Go-to-Light Service 4.0.0.2397 - 121 - API License to Cloud Demo

<back to all web services

ShowOnLedController

Requires Authentication
The following routes are available for this service:
All Verbs/ShowOnLedController/{LCAddress}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant}

export class ShowOnLedController
{
    /** @description Led Controller Address */
    // @ApiMember(Description="Led Controller Address", IsRequired=true)
    public LCAddress: string;

    /** @description HTML Color code (e.g. FF00FF) */
    // @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
    public Color: string;

    /** @description Pixel number */
    // @ApiMember(Description="Pixel number", 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<ShowOnLedController>) { (Object as any).assign(this, init); }
}

TypeScript ShowOnLedController DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /ShowOnLedController/{LCAddress}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"LCAddress":"String","Color":"String","Pixel":0,"Width":0,"Blink":false,"Persistant":false,"Delay":0,"Duration":0,"StockroomName":"String","Owner":"String","Unreliable":false}