Go-to-Light Service 3.1.1.1547 - 97 - API License to GTL Cloud

<back to all web services

ShowArea

Requires Authentication
The following routes are available for this service:
All Verbs/ShowArea/{AreaID}/{ColorStart}/{ColorStop}/{Duration}
ShowArea Parameters:
NameParameterData TypeRequiredDescription
AreaIDpathintYesArea ID
ColorStartpathstringYesHTML Color code (e.g. FF00FF) of the first pixel
ColorStoppathstringYesHTML Color code (e.g. FF00FF) of the last pixel
DurationpathintYesDuration in seconds
OwnerquerystringNoOptional: 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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"AreaID":0,"ColorStart":"String","ColorStop":"String","Duration":0,"Owner":"String"}