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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<HideOnAreaByName xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <AreaName>String</AreaName>
  <Color>String</Color>
  <Delay>0</Delay>
  <Owner>String</Owner>
  <Pixel>0</Pixel>
  <StockroomName>String</StockroomName>
</HideOnAreaByName>