| All Verbs | /Hide/{Key}/{Color} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | path | string | Yes | Key identifying a location |
| Color | path | string | Yes | HTML Color code (e.g. FF00FF) |
| Delay | query | int? | No | Optional: delay the execution of the command (in seconds) |
| StockroomName | query | string | No | Optional: name of the stockroom where to hide the position |
| 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 /Hide/{Key}/{Color} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<Hide xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Delay>0</Delay>
<Key>String</Key>
<Owner>String</Owner>
<StockroomName>String</StockroomName>
</Hide>