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

<back to all web services

SetPosition

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

export class SetPosition
{
    /** @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 AreaID: number;

    /** @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<SetPosition>) { (Object as any).assign(this, init); }
}

TypeScript SetPosition DTOs

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

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