All Verbs | /ShowPredictive/{BlinkKey}/{SteadyKey}/{Color}/{ShowHeader}/{Owner} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BlinkKey | path | string | Yes | Key identifying a location that will be shown blinking |
SteadyKey | path | string | Yes | Key identifying a location that will be shown not blinking |
Color | path | string | Yes | HTML Color code (e.g. FF00FF) |
ShowHeader | path | HeaderMode | Yes | Indicates the way the area header will be displayed (possible values are on, off, once) |
Owner | path | string | Yes | Name of the owner of the color/command to allow color sharing |
StockroomName | query | string | No | Optional: name of the stockroom where to show the position |
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>