| All Verbs | /ShowPredictive/{BlinkKey}/{SteadyKey}/{Color}/{ShowHeader}/{Owner} |
|---|
"use strict";
/** @typedef {'on'|'off'|'once'} */
export var HeaderMode;
(function (HeaderMode) {
HeaderMode["on"] = "on"
HeaderMode["off"] = "off"
HeaderMode["once"] = "once"
})(HeaderMode || (HeaderMode = {}));
export class ShowPredictive {
/** @param {{BlinkKey?:string,SteadyKey?:string,Color?:string,ShowHeader?:HeaderMode,Owner?:string,StockroomName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Key identifying a location that will be shown blinking */
BlinkKey;
/**
* @type {string}
* @description Key identifying a location that will be shown not blinking */
SteadyKey;
/**
* @type {string}
* @description HTML Color code (e.g. FF00FF) */
Color;
/**
* @type {HeaderMode}
* @description Indicates the way the area header will be displayed (possible values are on, off, once) */
ShowHeader;
/**
* @type {string}
* @description Name of the owner of the color/command to allow color sharing */
Owner;
/**
* @type {string}
* @description Optional: name of the stockroom where to show the position */
StockroomName;
}
JavaScript ShowPredictive 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 /ShowPredictive/{BlinkKey}/{SteadyKey}/{Color}/{ShowHeader}/{Owner} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowPredictive xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<BlinkKey>String</BlinkKey>
<Color>String</Color>
<Owner>String</Owner>
<ShowHeader>on</ShowHeader>
<SteadyKey>String</SteadyKey>
<StockroomName>String</StockroomName>
</ShowPredictive>