Go-to-Light Service 3.1.1.1547 - 97 - API License to GTL Cloud

<back to all web services

PBL_SwitchOnPosition

Requires Authentication
The following routes are available for this service:
All Verbs/PBL_SwitchOnPosition
PBL_SwitchOnPosition Parameters:
NameParameterData TypeRequiredDescription
PositionquerystringYesPosition identifying a LED location
Effectqueryint?NoOptional: 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
ColorquerystringNoOptional: HTML Color code (e.g. FF00FF)
HidePreviousPositionquerybool?NoOptional: When set to true, it turns off the same color in a previous position
OwnerquerystringNoOptional: name of the owner of the color/command to allow color sharing
PBL_StandardResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
ErrorformstringNo
ResultformObjectNo
ColorformstringNo

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

HTTP + JSON

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"}