| All Verbs | /PBL_SwitchOnPosition |
|---|
"use strict";
export class PBL_SwitchOnPosition {
/** @param {{Position?:string,Effect?:number,Color?:string,HidePreviousPosition?:boolean,Owner?:string,Duration?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Position identifying a LED location */
Position;
/**
* @type {?number}
* @description Optional: Animated effect selection: 0 = Always ON (no effect, default), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW */
Effect;
/**
* @type {string}
* @description Optional: HTML Color code (e.g. FF00FF) */
Color;
/**
* @type {?boolean}
* @description Optional: When set to true, it turns off the same color in a previous position */
HidePreviousPosition;
/**
* @type {string}
* @description Optional: name of the owner of the color/command to allow color sharing */
Owner;
/**
* @type {?number}
* @description Optional: duration of the show in seconds */
Duration;
}
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_SwitchOnPosition DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /PBL_SwitchOnPosition HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PBL_SwitchOnPosition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Duration>0</Duration>
<Effect>0</Effect>
<HidePreviousPosition>false</HidePreviousPosition>
<Owner>String</Owner>
<Position>String</Position>
</PBL_SwitchOnPosition>
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>