<back to all web services
ShowMultiple
The following routes are available for this service:All Verbs | /ShowMultiple/{Keys}/{Color}/{Blink}/{Persistant} | | |
---|
ShowMultiple Parameters:Name | Parameter | Data Type | Required | Description |
---|
Keys | path | string[] | Yes | Keys array identifying a location |
Blink | path | bool | Yes | Blinking or not |
ShowCommon Parameters:Name | Parameter | Data Type | Required | Description |
---|
Color | form | string | Yes | HTML Color code (e.g. FF00FF) |
Persistant | form | bool | Yes | When set to false, it turns off the same color in a previous position |
Delay | form | int? | No | Optional: delay the execution of the command (in seconds) |
Duration | form | int? | No | Optional: duration of the show in seconds |
StockroomName | form | string | No | Optional: name of the stockroom where to show the position |
Owner | form | string | No | Optional: name of the owner of the color/command to allow color sharing |
Unreliable | form | bool? | No | Optional: indicates if message shall be delivered in an unreliable way (faster) |
DisplayHeader | form | bool? | No | Optional: indicates if the header shall be displayed |
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 /ShowMultiple/{Keys}/{Color}/{Blink}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowMultiple xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Delay>0</Delay>
<DisplayHeader>false</DisplayHeader>
<Duration>0</Duration>
<Owner>String</Owner>
<Persistant>false</Persistant>
<StockroomName>String</StockroomName>
<Unreliable>false</Unreliable>
<Blink>false</Blink>
<Keys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Keys>
</ShowMultiple>