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

<back to all web services

SetPositionOnArea

Requires Authentication
The following routes are available for this service:
All Verbs/SetPositionOnArea/{Key}/{AreaName}/{Pixel}/{Width}
SetPositionOnArea Parameters:
NameParameterData TypeRequiredDescription
KeypathstringYesKey identifying a location
AreaNamepathstringYesArea ID
PixelpathintYesPixel number on the area
WidthpathintYesPixel width
StockroomNamequerystringNoOptional: name of the stockroom where the position is located
Overwritequerybool?NoOptional: overwrite existing positions defined with the same key: Yes by default

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 /SetPositionOnArea/{Key}/{AreaName}/{Pixel}/{Width} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Key":"String","AreaName":"String","Pixel":0,"Width":0,"StockroomName":"String","Overwrite":false}