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

<back to all web services

ShowOnArea

Requires Authentication
The following routes are available for this service:
All Verbs/ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant}
ShowOnArea Parameters:
NameParameterData TypeRequiredDescription
AreaIDpathintYesArea ID
ColorpathstringYesHTML Color code (e.g. FF00FF)
PixelpathintYesPixel number on the area
WidthpathintYesPixel width
BlinkpathboolYesBlinking or not
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
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 /ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AreaID: 0,
	Color: String,
	Pixel: 0,
	Width: 0,
	Blink: False,
	Persistant: False,
	Delay: 0,
	Duration: 0,
	Owner: String,
	Unreliable: False
}