| All Verbs | /HideOnAreaByName/{AreaName}/{Color}/{Pixel} |
|---|
export class HideOnAreaByName
{
/** @description Area Name */
// @ApiMember(Description="Area Name", IsRequired=true)
public AreaName: string;
/** @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 stockroom where the area is located */
// @ApiMember(Description="Optional: name of the stockroom where the area is located")
public StockroomName: string;
/** @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<HideOnAreaByName>) { (Object as any).assign(this, init); }
}
TypeScript 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>