| All Verbs | /PBL_SwitchOnPosition |
|---|
export class PBL_SwitchOnPosition
{
/** @description Position identifying a LED location */
// @ApiMember(Description="Position identifying a LED location", IsRequired=true)
public Position: string;
/** @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 */
// @ApiMember(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")
public Effect?: number;
/** @description Optional: HTML Color code (e.g. FF00FF) */
// @ApiMember(Description="Optional: HTML Color code (e.g. FF00FF)")
public Color: string;
/** @description Optional: When set to true, it turns off the same color in a previous position */
// @ApiMember(Description="Optional: When set to true, it turns off the same color in a previous position")
public HidePreviousPosition?: boolean;
/** @description Optional: name of the owner of the color/command to allow color sharing */
// @ApiMember(Description="Optional: name of the owner of the color/command to allow color sharing")
public Owner: string;
/** @description Optional: duration of the show in seconds */
// @ApiMember(Description="Optional: duration of the show in seconds")
public Duration?: number;
public constructor(init?: Partial<PBL_SwitchOnPosition>) { (Object as any).assign(this, init); }
}
export class PBL_StandardResponse
{
public Success: boolean;
public Error: string;
public Result: Object;
public Color: string;
public constructor(init?: Partial<PBL_StandardResponse>) { (Object as any).assign(this, init); }
}
TypeScript PBL_SwitchOnPosition 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_SwitchOnPosition HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Position: String,
Effect: 0,
Color: String,
HidePreviousPosition: False,
Owner: String,
Duration: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Success: False,
Error: String,
Result: {},
Color: String
}