| All Verbs | /ShowArea/{AreaID}/{ColorStart}/{ColorStop}/{Duration} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AreaID | path | int | Yes | Area ID |
| ColorStart | path | string | Yes | HTML Color code (e.g. FF00FF) of the first pixel |
| ColorStop | path | string | Yes | HTML Color code (e.g. FF00FF) of the last pixel |
| Duration | path | int | Yes | Duration in seconds |
| Owner | query | string | No | Optional: name of the owner of the color/command to allow color sharing |
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 /ShowArea/{AreaID}/{ColorStart}/{ColorStop}/{Duration} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<AreaID>0</AreaID>
<ColorStart>String</ColorStart>
<ColorStop>String</ColorStop>
<Duration>0</Duration>
<Owner>String</Owner>
</ShowArea>