| All Verbs | /HideOnAreaByName/{AreaName}/{Color}/{Pixel} |
|---|
"use strict";
export class HideOnAreaByName {
/** @param {{AreaName?:string,Color?:string,Pixel?:number,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 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 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 HideOnAreaByName DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /HideOnAreaByName/{AreaName}/{Color}/{Pixel} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<HideOnAreaByName 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>
<Pixel>0</Pixel>
<StockroomName>String</StockroomName>
</HideOnAreaByName>