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

<back to all web services

SetPositions

Requires Authentication
The following routes are available for this service:
All Verbs/SetPositions
SetPositions Parameters:
NameParameterData TypeRequiredDescription
PositionsqueryPosition[]YesKey identifying a location
StockroomNamequerystringNoOptional: name of the stockroom where the position is located
Overwritequerybool?NoOptional: overwrite existing positions defined with the same key: Yes by default
Position Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
KeyformstringNo
PixelformintNo
WidthformintNo
AreaIDformintNo
AreaLabelformstringNo
LabelformstringNo
StockroomIDformlong?No

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 /SetPositions HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Positions: 
	[
		{
			ID: 0,
			Key: String,
			Pixel: 0,
			Width: 0,
			AreaID: 0,
			AreaLabel: String,
			Label: String,
			StockroomID: 0
		}
	],
	StockroomName: String,
	Overwrite: False
}