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

<back to all web services

ShowOnLedControllerEx

Requires Authentication
The following routes are available for this service:
All Verbs/ShowOnLedControllerEx/{LCAddress}/{Color}/{Pixel}/{Width}/{Effect}/{Persistant}
ShowOnLedControllerEx Parameters:
NameParameterData TypeRequiredDescription
LCAddresspathstringYesLed Controller Address
ColorpathstringYesHTML Color code (e.g. FF00FF)
PixelpathintYesPixel number
WidthpathintYesPixel width
Effectpathint?YesAnimated effect selection: 0 = Always ON (no effect), 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
PersistantpathboolYesWhen set to false, it turns off the same color in a previous position
Delayqueryint?NoOptional: delay the execution of the command (in seconds)
Durationqueryint?NoOptional: duration of the show in seconds
StockroomNamequerystringNoOptional: name of the stockroom where the area is located
OwnerquerystringNoOptional: name of the owner of the color/command to allow color sharing
Unreliablequerybool?NoOptional: indicates if message shall be delivered in an unreliable way (faster)

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /ShowOnLedControllerEx/{LCAddress}/{Color}/{Pixel}/{Width}/{Effect}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	LCAddress: String,
	Color: String,
	Pixel: 0,
	Width: 0,
	Effect: 0,
	Persistant: False,
	Delay: 0,
	Duration: 0,
	StockroomName: String,
	Owner: String,
	Unreliable: False
}