| All Verbs | /PBL_SwitchOffPositions |
|---|
"use strict";
export class PBL_SwitchOffPositions {
/** @param {{Positions?:string[],Color?:string,Owner?:string,SwitchOffAnyColor?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string[]}
* @description Positions identifying LED locations */
Positions = [];
/**
* @type {string}
* @description Optional: HTML Color code (e.g. FF00FF) */
Color;
/**
* @type {string}
* @description Optional: name of the owner of the color/command to allow color sharing */
Owner;
/**
* @type {?boolean}
* @description Optional: set paramter to TRUE if you need to turn off any color previously turned ON at specified positions */
SwitchOffAnyColor;
}
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_SwitchOffPositions DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /PBL_SwitchOffPositions HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Positions:
[
String
],
Color: String,
Owner: String,
SwitchOffAnyColor: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Success: False,
Error: String,
Result: {},
Color: String
}