All Verbs | /PBL_SwitchOffPosition |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Position | query | string | Yes | Position identifying a LED location |
Color | query | string | No | Optional: HTML Color code (e.g. FF00FF) |
Owner | query | string | No | Optional: name of the owner of the color/command to allow color sharing |
SwitchOffAnyColor | query | bool | No | Optional: set paramter to TRUE if you need to turn off any color previously turned ON at specified position |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Success | form | bool | No | |
Error | form | string | No | |
Result | form | Object | No | |
Color | form | string | No |
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 /PBL_SwitchOffPosition HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Position: String,
Color: String,
Owner: String,
SwitchOffAnyColor: False
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Success: False, Error: String, Result: {}, Color: String }