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}
"use strict";
export class SetPosition {
    /** @param {{Key?:string,AreaID?:number,Pixel?:number,Width?:number,StockroomName?:string,Overwrite?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Key identifying a location */
    Key;
    /**
     * @type {number}
     * @description Area ID */
    AreaID;
    /**
     * @type {number}
     * @description Pixel number on the area */
    Pixel;
    /**
     * @type {number}
     * @description Pixel width */
    Width;
    /**
     * @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 SetPosition DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

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