| All Verbs | /ShowOnAreaByName/{AreaName}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} |
|---|
export class ShowOnAreaByName
{
/** @description Area Name */
// @ApiMember(Description="Area Name", IsRequired=true)
public AreaName: string;
/** @description HTML Color code (e.g. FF00FF) */
// @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
public Color: string;
/** @description Pixel number on the area */
// @ApiMember(Description="Pixel number on the area", IsRequired=true)
public Pixel: number;
/** @description Pixel width */
// @ApiMember(Description="Pixel width", IsRequired=true)
public Width: number;
/** @description Blinking or not */
// @ApiMember(Description="Blinking or not", IsRequired=true)
public Blink: boolean;
/** @description When set to false, it turns off the same color in a previous position */
// @ApiMember(Description="When set to false, it turns off the same color in a previous position", IsRequired=true)
public Persistant: boolean;
/** @description Optional: delay the execution of the command (in seconds) */
// @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
public Delay?: number;
/** @description Optional: duration of the show in seconds */
// @ApiMember(Description="Optional: duration of the show in seconds")
public Duration?: number;
/** @description Optional: name of the stockroom where the area is located */
// @ApiMember(Description="Optional: name of the stockroom where the area is located")
public StockroomName: string;
/** @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: indicates if message shall be delivered in an unreliable way (faster) */
// @ApiMember(Description="Optional: indicates if message shall be delivered in an unreliable way (faster)")
public Unreliable?: boolean;
public constructor(init?: Partial<ShowOnAreaByName>) { (Object as any).assign(this, init); }
}
TypeScript ShowOnAreaByName DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ShowOnAreaByName/{AreaName}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"AreaName":"String","Color":"String","Pixel":0,"Width":0,"Blink":false,"Persistant":false,"Delay":0,"Duration":0,"StockroomName":"String","Owner":"String","Unreliable":false}