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

<back to all web services

HideMultipleEx

Requires Authentication
The following routes are available for this service:
All Verbs/HideMultipleEx

export class KeyToHide
{
    /** @description Key identifying a location */
    // @ApiMember(Description="Key identifying a location", IsRequired=true)
    public Key: string;

    /** @description HTML Color code (e.g. FF00FF) */
    // @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
    public Color: string;

    public constructor(init?: Partial<KeyToHide>) { (Object as any).assign(this, init); }
}

export class HideMultipleEx
{
    /** @description List of key object (KeyToHide) to hide */
    // @ApiMember(Description="List of key object (KeyToHide) to hide", IsRequired=true)
    public Keys: KeyToHide[] = [];

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

    /** @description Optional: name of the stockroom where to show the position */
    // @ApiMember(Description="Optional: name of the stockroom where to show the position")
    public StockroomName: string;

    /** @description Name of the owner of the color/command to allow color sharing */
    // @ApiMember(Description="Name of the owner of the color/command to allow color sharing")
    public Owner: string;

    public constructor(init?: Partial<HideMultipleEx>) { (Object as any).assign(this, init); }
}

TypeScript HideMultipleEx DTOs

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

HTTP + JSV

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

POST /HideMultipleEx HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Keys: 
	[
		{
			Key: String,
			Color: String
		}
	],
	Delay: 0,
	StockroomName: String,
	Owner: String
}