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

<back to all web services

ShowEffect

Requires Authentication
The following routes are available for this service:
All Verbs/ShowEffect/{Key}/{Color}/{Effect}/{Persistant}
ShowEffect Parameters:
NameParameterData TypeRequiredDescription
KeypathstringYesKey identifying a location
EffectpathintYesAnimated 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
ShowCommon Parameters:
NameParameterData TypeRequiredDescription
ColorformstringYesHTML Color code (e.g. FF00FF)
PersistantformboolYesWhen set to false, it turns off the same color in a previous position
Delayformint?NoOptional: delay the execution of the command (in seconds)
Durationformint?NoOptional: duration of the show in seconds
StockroomNameformstringNoOptional: name of the stockroom where to show the position
OwnerformstringNoOptional: name of the owner of the color/command to allow color sharing
Unreliableformbool?NoOptional: indicates if message shall be delivered in an unreliable way (faster)
DisplayHeaderformbool?NoOptional: indicates if the header shall be displayed

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 /ShowEffect/{Key}/{Color}/{Effect}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Key: String,
	Effect: 0,
	Color: String,
	Persistant: False,
	Delay: 0,
	Duration: 0,
	StockroomName: String,
	Owner: String,
	Unreliable: False,
	DisplayHeader: False
}