| All Verbs | /PBL_SwitchOnPosition |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Position | query | string | Yes | Position identifying a LED location |
| Effect | query | int? | No | Optional: Animated effect selection: 0 = Always ON (no effect, default), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW |
| Color | query | string | No | Optional: HTML Color code (e.g. FF00FF) |
| HidePreviousPosition | query | bool? | No | Optional: When set to true, it turns off the same color in a previous position |
| Owner | query | string | No | Optional: name of the owner of the color/command to allow color sharing |
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /PBL_SwitchOnPosition HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Position":"String","Effect":0,"Color":"String","HidePreviousPosition":false,"Owner":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Success":false,"Error":"String","Result":{},"Color":"String"}