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}
"use strict";
export class HideOnArea {
    /** @param {{AreaID?:number,Color?:string,Pixel?:number,Delay?:number,Owner?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Area ID */
    AreaID;
    /**
     * @type {string}
     * @description HTML Color code (e.g. FF00FF) */
    Color;
    /**
     * @type {number}
     * @description Pixel number on the group */
    Pixel;
    /**
     * @type {?number}
     * @description Optional: delay the execution of the command (in seconds) */
    Delay;
    /**
     * @type {string}
     * @description Optional: name of the owner of the color/command to allow color sharing */
    Owner;
}

JavaScript 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>