Go-to-Light Service 4.0.0.2397 - 121 - API License to Cloud Demo

<back to all web services

Hide

Requires Authentication
The following routes are available for this service:
All Verbs/Hide/{Key}/{Color}
import 'package:servicestack/servicestack.dart';

class Hide implements IConvertible
{
    /**
    * Key identifying a location
    */
    // @ApiMember(Description="Key identifying a location", IsRequired=true)
    String? Key;

    /**
    * HTML Color code (e.g. FF00FF)
    */
    // @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
    String? Color;

    /**
    * Optional: delay the execution of the command (in seconds)
    */
    // @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
    int? Delay;

    /**
    * Optional: name of the stockroom where to hide the position
    */
    // @ApiMember(Description="Optional: name of the stockroom where to hide the position")
    String? StockroomName;

    /**
    * Optional: name of the owner of the color/command to allow color sharing
    */
    // @ApiMember(Description="Optional: name of the owner of the color/command to allow color sharing")
    String? Owner;

    Hide({this.Key,this.Color,this.Delay,this.StockroomName,this.Owner});
    Hide.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Key = json['Key'];
        Color = json['Color'];
        Delay = json['Delay'];
        StockroomName = json['StockroomName'];
        Owner = json['Owner'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Key': Key,
        'Color': Color,
        'Delay': Delay,
        'StockroomName': StockroomName,
        'Owner': Owner
    };

    getTypeName() => "Hide";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'clouddemo.pickeos.com', types: <String, TypeInfo> {
    'Hide': TypeInfo(TypeOf.Class, create:() => Hide()),
});

Dart Hide DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Hide/{Key}/{Color} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Key":"String","Color":"String","Delay":0,"StockroomName":"String","Owner":"String"}