| All Verbs | /ShowMultipleEx/{Color}/{Persistant} |
|---|
"use strict";
export class KeyToDisplay {
/** @param {{Key?:string,Blink?:boolean,ShowHeader?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Key identifying a location */
Key;
/**
* @type {boolean}
* @description Blinking or not */
Blink;
/**
* @type {boolean}
* @description Indicates whether we show the area header of the blinking key or not */
ShowHeader;
}
export class ShowMultipleEx {
/** @param {{Color?:string,Persistant?:boolean,Keys?:KeyToDisplay[],Delay?:number,Duration?:number,StockroomName?:string,Owner?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description HTML Color code (e.g. FF00FF) */
Color;
/**
* @type {boolean}
* @description When set to false, it turns off the same color in a previous position */
Persistant;
/**
* @type {KeyToDisplay[]}
* @description List of key object (KeyToDisplay) to display */
Keys = [];
/**
* @type {?number}
* @description Optional: delay the execution of the command (in seconds) */
Delay;
/**
* @type {?number}
* @description Optional: duration of the show in seconds */
Duration;
/**
* @type {string}
* @description Optional: name of the stockroom where to show the position */
StockroomName;
/**
* @type {string}
* @description Name of the owner of the color/command to allow color sharing */
Owner;
}
JavaScript ShowMultipleEx DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ShowMultipleEx/{Color}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowMultipleEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Delay>0</Delay>
<Duration>0</Duration>
<Keys>
<KeyToDisplay>
<Blink>false</Blink>
<Key>String</Key>
<ShowHeader>false</ShowHeader>
</KeyToDisplay>
</Keys>
<Owner>String</Owner>
<Persistant>false</Persistant>
<StockroomName>String</StockroomName>
</ShowMultipleEx>