| All Verbs | /ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} |
|---|
"use strict";
export class ShowOnArea {
/** @param {{AreaID?:number,Color?:string,Pixel?:number,Width?:number,Blink?:boolean,Persistant?:boolean,Delay?:number,Duration?:number,Owner?:string,Unreliable?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Area ID */
AreaID;
/**
* @type {string}
* @description HTML Color code (e.g. FF00FF) */
Color;
/**
* @type {number}
* @description Pixel number on the area */
Pixel;
/**
* @type {number}
* @description Pixel width */
Width;
/**
* @type {boolean}
* @description Blinking or not */
Blink;
/**
* @type {boolean}
* @description When set to false, it turns off the same color in a previous position */
Persistant;
/**
* @type {?number}
* @description Optional: delay the execution of the command (in seconds) */
Delay;
/**
* @type {?number}
* @description Optional: duration of the show in seconds */
Duration;
/**
* @type {string}
* @description Optional: name of the owner of the color/command to allow color sharing */
Owner;
/**
* @type {?boolean}
* @description Optional: indicates if message shall be delivered in an unreliable way (faster) */
Unreliable;
}
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 /ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowOnArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<AreaID>0</AreaID>
<Blink>false</Blink>
<Color>String</Color>
<Delay>0</Delay>
<Duration>0</Duration>
<Owner>String</Owner>
<Persistant>false</Persistant>
<Pixel>0</Pixel>
<Unreliable>false</Unreliable>
<Width>0</Width>
</ShowOnArea>