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

<back to all web services

SetPositions

Requires Authentication
The following routes are available for this service:
All Verbs/SetPositions
"use strict";
export class Position {
    /** @param {{ID?:number,Key?:string,Pixel?:number,Width?:number,AreaID?:number,AreaLabel?:string,Label?:string,StockroomID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    Key;
    /** @type {number} */
    Pixel;
    /** @type {number} */
    Width;
    /** @type {number} */
    AreaID;
    /** @type {string} */
    AreaLabel;
    /** @type {string} */
    Label;
    /** @type {?number} */
    StockroomID;
}
export class SetPositions {
    /** @param {{Positions?:Position[],StockroomName?:string,Overwrite?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Position[]}
     * @description Key identifying a location */
    Positions = [];
    /**
     * @type {string}
     * @description Optional: name of the stockroom where the position is located */
    StockroomName;
    /**
     * @type {?boolean}
     * @description Optional: overwrite existing positions defined with the same key: Yes by default */
    Overwrite;
}

JavaScript SetPositions 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 /SetPositions HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Positions: 
	[
		{
			ID: 0,
			Key: String,
			Pixel: 0,
			Width: 0,
			AreaID: 0,
			AreaLabel: String,
			Label: String,
			StockroomID: 0
		}
	],
	StockroomName: String,
	Overwrite: False
}