Go-to-Light Service 4.0.0.2397 - 121 - API License to Cloud Demo

<back to all web services

DefineAreas

Requires Authentication
The following routes are available for this service:
All Verbs/DefineAreas/{Areas}
"use strict";
export class AreaContent {
    /** @param {{ID?:number,LCAddress?:string,PixelStart?:number,PixelStop?:number,AreaID?:number,Pos?:number,Reverse?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    LCAddress;
    /** @type {number} */
    PixelStart;
    /** @type {number} */
    PixelStop;
    /** @type {number} */
    AreaID;
    /** @type {number} */
    Pos;
    /** @type {boolean} */
    Reverse;
}
export class Area {
    /** @param {{AreaID?:number,Label?:string,StockroomID?:number,Content?:AreaContent[],NumberOfPixels?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AreaID;
    /** @type {string} */
    Label;
    /** @type {?number} */
    StockroomID;
    /** @type {AreaContent[]} */
    Content = [];
    /** @type {number} */
    NumberOfPixels;
}
export class DefineAreas {
    /** @param {{Areas?:Area[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Area[]}
     * @description Areas */
    Areas = [];
}

JavaScript DefineAreas DTOs

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>