| All Verbs | /ShowMultipleEx/{Color}/{Persistant} |
|---|
export class KeyToDisplay
{
/** @description Key identifying a location */
// @ApiMember(Description="Key identifying a location", IsRequired=true)
public Key: string;
/** @description Blinking or not */
// @ApiMember(Description="Blinking or not", IsRequired=true)
public Blink: boolean;
/** @description Indicates whether we show the area header of the blinking key or not */
// @ApiMember(Description="Indicates whether we show the area header of the blinking key or not", IsRequired=true)
public ShowHeader: boolean;
public constructor(init?: Partial<KeyToDisplay>) { (Object as any).assign(this, init); }
}
export class ShowMultipleEx
{
/** @description HTML Color code (e.g. FF00FF) */
// @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
public Color: string;
/** @description When set to false, it turns off the same color in a previous position */
// @ApiMember(Description="When set to false, it turns off the same color in a previous position", IsRequired=true)
public Persistant: boolean;
/** @description List of key object (KeyToDisplay) to display */
// @ApiMember(Description="List of key object (KeyToDisplay) to display", IsRequired=true)
public Keys: KeyToDisplay[] = [];
/** @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: duration of the show in seconds */
// @ApiMember(Description="Optional: duration of the show in seconds")
public Duration?: 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<ShowMultipleEx>) { (Object as any).assign(this, init); }
}
TypeScript ShowMultipleEx DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Color: String,
Persistant: False,
Keys:
[
{
Key: String,
Blink: False,
ShowHeader: False
}
],
Delay: 0,
Duration: 0,
StockroomName: String,
Owner: String
}