All Verbs | /HideOnAreaByName/{AreaName}/{Color}/{Pixel} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AreaName | path | string | Yes | Area Name |
Color | path | string | Yes | HTML Color code (e.g. FF00FF) |
Pixel | path | int | Yes | Pixel number on the group |
Delay | query | int? | No | Optional: delay the execution of the command (in seconds) |
StockroomName | query | string | No | Optional: name of the stockroom where the area is located |
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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AreaName: String,
Color: String,
Pixel: 0,
Delay: 0,
StockroomName: String,
Owner: String
}