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

<back to all web services

SetPositionOnArea

Requires Authentication
The following routes are available for this service:
All Verbs/SetPositionOnArea/{Key}/{AreaName}/{Pixel}/{Width}

export class SetPositionOnArea
{
    /** @description Key identifying a location */
    // @ApiMember(Description="Key identifying a location", IsRequired=true)
    public Key: string;

    /** @description Area ID */
    // @ApiMember(Description="Area ID", IsRequired=true)
    public AreaName: string;

    /** @description Pixel number on the area */
    // @ApiMember(Description="Pixel number on the area", IsRequired=true)
    public Pixel: number;

    /** @description Pixel width */
    // @ApiMember(Description="Pixel width", IsRequired=true)
    public Width: number;

    /** @description Optional: name of the stockroom where the position is located */
    // @ApiMember(Description="Optional: name of the stockroom where the position is located")
    public StockroomName: string;

    /** @description Optional: overwrite existing positions defined with the same key: Yes by default */
    // @ApiMember(Description="Optional: overwrite existing positions defined with the same key: Yes by default")
    public Overwrite?: boolean;

    public constructor(init?: Partial<SetPositionOnArea>) { (Object as any).assign(this, init); }
}

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

<SetPositionOnArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <AreaName>String</AreaName>
  <Key>String</Key>
  <Overwrite>false</Overwrite>
  <Pixel>0</Pixel>
  <StockroomName>String</StockroomName>
  <Width>0</Width>
</SetPositionOnArea>