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

<back to all web services

HideOnAreaByName

Requires Authentication
The following routes are available for this service:
All Verbs/HideOnAreaByName/{AreaName}/{Color}/{Pixel}
HideOnAreaByName Parameters:
NameParameterData TypeRequiredDescription
AreaNamepathstringYesArea Name
ColorpathstringYesHTML Color code (e.g. FF00FF)
PixelpathintYesPixel number on the group
Delayqueryint?NoOptional: delay the execution of the command (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

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /HideOnAreaByName/{AreaName}/{Color}/{Pixel} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AreaName":"String","Color":"String","Pixel":0,"Delay":0,"StockroomName":"String","Owner":"String"}