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

<back to all web services

PBL_SetFreePosition

Requires Authentication
The following routes are available for this service:
All Verbs/PBL_SetFreePosition/{Key}/{LCAddress}/{PixelBegin}/{PixelEnd}/{OutputNumber}
"use strict";
export class PBL_SetFreePosition {
    /** @param {{Key?:string,LCAddress?:string,PixelBegin?:number,PixelEnd?:number,OutputNumber?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Key identifying a location */
    Key;
    /**
     * @type {string}
     * @description LCAddress */
    LCAddress;
    /**
     * @type {number}
     * @description Number of first pixel */
    PixelBegin;
    /**
     * @type {number}
     * @description Number of last pixel */
    PixelEnd;
    /**
     * @type {number}
     * @description Output number */
    OutputNumber;
}
export class PBL_StandardResponse {
    /** @param {{Success?:boolean,Error?:string,Result?:Object,Color?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Success;
    /** @type {string} */
    Error;
    /** @type {Object} */
    Result;
    /** @type {string} */
    Color;
}

JavaScript PBL_SetFreePosition 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 /PBL_SetFreePosition/{Key}/{LCAddress}/{PixelBegin}/{PixelEnd}/{OutputNumber} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PBL_SetFreePosition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Key>String</Key>
  <LCAddress>String</LCAddress>
  <OutputNumber>0</OutputNumber>
  <PixelBegin>0</PixelBegin>
  <PixelEnd>0</PixelEnd>
</PBL_SetFreePosition>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PBL_StandardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Error>String</Error>
  <Result />
  <Success>false</Success>
</PBL_StandardResponse>