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

<back to all web services

HideOnArea

Requires Authentication
The following routes are available for this service:
All Verbs/HideOnArea/{AreaID}/{Color}/{Pixel}

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

    /** @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 group */
    // @ApiMember(Description="Pixel number on the group", IsRequired=true)
    public Pixel: number;

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

TypeScript HideOnArea 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 /HideOnArea/{AreaID}/{Color}/{Pixel} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<HideOnArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <AreaID>0</AreaID>
  <Color>String</Color>
  <Delay>0</Delay>
  <Owner>String</Owner>
  <Pixel>0</Pixel>
</HideOnArea>