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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Key: String,
	AreaName: String,
	Pixel: 0,
	Width: 0,
	StockroomName: String,
	Overwrite: False
}