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

<back to all web services

ShowArea

Requires Authentication
The following routes are available for this service:
All Verbs/ShowArea/{AreaID}/{ColorStart}/{ColorStop}/{Duration}

export class ShowArea
{
    /** @description Area ID */
    // @ApiMember(Description="Area ID", IsRequired=true)
    public AreaID: number;

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

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

    /** @description Duration in seconds */
    // @ApiMember(Description="Duration in seconds", IsRequired=true)
    public Duration: number;

    /** @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;

    public constructor(init?: Partial<ShowArea>) { (Object as any).assign(this, init); }
}

TypeScript ShowArea DTOs

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

HTTP + OTHER

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

POST /ShowArea/{AreaID}/{ColorStart}/{ColorStop}/{Duration} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"AreaID":0,"ColorStart":"String","ColorStop":"String","Duration":0,"Owner":"String"}