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

<back to all web services

DefineAreas

Requires Authentication
Required role:admin
The following routes are available for this service:
All Verbs/DefineAreas/{Areas}
DefineAreas Parameters:
NameParameterData TypeRequiredDescription
AreaspathArea[]YesAreas
Area Parameters:
NameParameterData TypeRequiredDescription
AreaIDformintNo
LabelformstringNo
StockroomIDformlong?No
ContentformList<AreaContent>No
NumberOfPixelsformintNo
AreaContent Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
LCAddressformstringNo
PixelStartformintNo
PixelStopformintNo
AreaIDformintNo
PosformintNo
ReverseformboolNo

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

HTTP + CSV

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

POST /DefineAreas/{Areas} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Areas":[{"AreaID":0,"Label":"String","StockroomID":0,"Content":[{"ID":0,"LCAddress":"String","PixelStart":0,"PixelStop":0,"AreaID":0,"Pos":0,"Reverse":false}],"NumberOfPixels":1}]}