<back to all web services
ShowMultipleEx
The following routes are available for this service:All Verbs | /ShowMultipleEx/{Color}/{Persistant} | | |
---|
ShowMultipleEx Parameters:Name | Parameter | Data Type | Required | Description |
---|
Color | path | string | Yes | HTML Color code (e.g. FF00FF) |
Persistant | path | bool | Yes | When set to false, it turns off the same color in a previous position |
Keys | query | List<KeyToDisplay> | Yes | List of key object (KeyToDisplay) to display |
Delay | query | int? | No | Optional: delay the execution of the command (in seconds) |
Duration | query | int? | No | Optional: duration of the show in seconds |
StockroomName | query | string | No | Optional: name of the stockroom where to show the position |
Owner | query | string | No | Name of the owner of the color/command to allow color sharing |
KeyToDisplay Parameters:Name | Parameter | Data Type | Required | Description |
---|
Key | form | string | Yes | Key identifying a location |
Blink | form | bool | Yes | Blinking or not |
ShowHeader | form | bool | Yes | Indicates whether we show the area header of the blinking key or not |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + 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>