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

<back to all web services

ShowOnLedControllerEx

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

export class ShowOnLedControllerEx
{
    /** @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 Animated effect selection: 0 = Always ON (no effect), 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="Animated effect selection: 0 = Always ON (no effect), 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", IsRequired=true)
    public Effect: number;

    /** @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<ShowOnLedControllerEx>) { (Object as any).assign(this, init); }
}

TypeScript ShowOnLedControllerEx DTOs

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

HTTP + XML

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

POST /ShowOnLedControllerEx/{LCAddress}/{Color}/{Pixel}/{Width}/{Effect}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ShowOnLedControllerEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Delay>0</Delay>
  <Duration>0</Duration>
  <Effect>0</Effect>
  <LCAddress>String</LCAddress>
  <Owner>String</Owner>
  <Persistant>false</Persistant>
  <Pixel>0</Pixel>
  <StockroomName>String</StockroomName>
  <Unreliable>false</Unreliable>
  <Width>0</Width>
</ShowOnLedControllerEx>