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

<back to all web services

SaveArea

Requires Authentication
The following routes are available for this service:
All Verbs/SaveArea/{Area}
"use strict";
export class AreaContent {
    /** @param {{ID?:number,LCAddress?:string,PixelStart?:number,PixelStop?:number,AreaID?:number,Pos?:number,Reverse?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    LCAddress;
    /** @type {number} */
    PixelStart;
    /** @type {number} */
    PixelStop;
    /** @type {number} */
    AreaID;
    /** @type {number} */
    Pos;
    /** @type {boolean} */
    Reverse;
}
export class Area {
    /** @param {{AreaID?:number,Label?:string,StockroomID?:number,Content?:AreaContent[],NumberOfPixels?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AreaID;
    /** @type {string} */
    Label;
    /** @type {?number} */
    StockroomID;
    /** @type {AreaContent[]} */
    Content = [];
    /** @type {number} */
    NumberOfPixels;
}
export class SaveArea {
    /** @param {{Area?:Area}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Area}
     * @description Area */
    Area;
}

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

{
	Area: 
	{
		AreaID: 0,
		Label: String,
		StockroomID: 0,
		Content: 
		[
			{
				ID: 0,
				LCAddress: String,
				PixelStart: 0,
				PixelStop: 0,
				AreaID: 0,
				Pos: 0,
				Reverse: False
			}
		],
		NumberOfPixels: 1
	}
}