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}
"use strict";
export class Hide {
    /** @param {{Key?:string,Color?:string,Delay?:number,StockroomName?:string,Owner?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Key identifying a location */
    Key;
    /**
     * @type {string}
     * @description HTML Color code (e.g. FF00FF) */
    Color;
    /**
     * @type {?number}
     * @description Optional: delay the execution of the command (in seconds) */
    Delay;
    /**
     * @type {string}
     * @description Optional: name of the stockroom where to hide the position */
    StockroomName;
    /**
     * @type {string}
     * @description Optional: name of the owner of the color/command to allow color sharing */
    Owner;
}

JavaScript Hide DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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