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

<back to all web services

ShowOnAreaByName

Requires Authentication
The following routes are available for this service:
All Verbs/ShowOnAreaByName/{AreaName}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant}
ShowOnAreaByName Parameters:
NameParameterData TypeRequiredDescription
AreaNamepathstringYesArea Name
ColorpathstringYesHTML Color code (e.g. FF00FF)
PixelpathintYesPixel number on the area
WidthpathintYesPixel width
BlinkpathboolYesBlinking or not
PersistantpathboolYesWhen set to false, it turns off the same color in a previous position
Delayqueryint?NoOptional: delay the execution of the command (in seconds)
Durationqueryint?NoOptional: duration of the show in seconds
StockroomNamequerystringNoOptional: name of the stockroom where the area is located
OwnerquerystringNoOptional: name of the owner of the color/command to allow color sharing
Unreliablequerybool?NoOptional: 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 .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 /ShowOnAreaByName/{AreaName}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"AreaName":"String","Color":"String","Pixel":0,"Width":0,"Blink":false,"Persistant":false,"Delay":0,"Duration":0,"StockroomName":"String","Owner":"String","Unreliable":false}