| All Verbs | /PBL_SwitchOffPosition |
|---|
"use strict";
export class PBL_SwitchOffPosition {
/** @param {{Position?:string,Color?:string,Owner?:string,SwitchOffAnyColor?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Position identifying a LED location */
Position;
/**
* @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 position */
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_SwitchOffPosition DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /PBL_SwitchOffPosition HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Position":"String","Color":"String","Owner":"String","SwitchOffAnyColor":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Success":false,"Error":"String","Result":{},"Color":"String"}