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

<back to all web services

HideColorOnAreaByName

Requires Authentication
The following routes are available for this service:
All Verbs/HideColorOnAreaByName/{AreaName}/{Color}
"use strict";
export class HideColorOnAreaByName {
    /** @param {{AreaName?:string,Color?:string,Delay?:number,StockroomName?:string,Owner?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Area Name */
    AreaName;
    /**
     * @type {string}
     * @description HTML Color code (e.g. FF00FF) */
    Color;
    /**
     * @type {?number}
     * @description Optional: delay the execution of the command (in seconds) */
    Delay;
    /**
     * @type {string}
     * @description Optional: name of the stockroom where the area is located */
    StockroomName;
    /**
     * @type {string}
     * @description Optional: name of the owner of the color/command to allow color sharing */
    Owner;
}

JavaScript HideColorOnAreaByName 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 /HideColorOnAreaByName/{AreaName}/{Color} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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