| All Verbs | /ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AreaID | path | int | Yes | Area ID |
| Color | path | string | Yes | HTML Color code (e.g. FF00FF) |
| Pixel | path | int | Yes | Pixel number on the area |
| Width | path | int | Yes | Pixel width |
| Blink | path | bool | Yes | Blinking or not |
| Persistant | path | bool | Yes | When set to false, it turns off the same color in a previous position |
| Delay | query | int? | No | Optional: delay the execution of the command (in seconds) |
| Duration | query | int? | No | Optional: duration of the show in seconds |
| Owner | query | string | No | Optional: name of the owner of the color/command to allow color sharing |
| Unreliable | query | bool? | No | Optional: indicates if message shall be delivered in an unreliable way (faster) |
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 /ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowOnArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<AreaID>0</AreaID>
<Blink>false</Blink>
<Color>String</Color>
<Delay>0</Delay>
<Duration>0</Duration>
<Owner>String</Owner>
<Persistant>false</Persistant>
<Pixel>0</Pixel>
<Unreliable>false</Unreliable>
<Width>0</Width>
</ShowOnArea>