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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<DefineAreas xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Areas>
    <Area>
      <AreaID>0</AreaID>
      <Content>
        <AreaContent>
          <AreaID>0</AreaID>
          <ID>0</ID>
          <LCAddress>String</LCAddress>
          <PixelStart>0</PixelStart>
          <PixelStop>0</PixelStop>
          <Pos>0</Pos>
          <Reverse>false</Reverse>
        </AreaContent>
      </Content>
      <Label>String</Label>
      <StockroomID>0</StockroomID>
    </Area>
  </Areas>
</DefineAreas>