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

<back to all web services

Hide

Requires Authentication
The following routes are available for this service:
All Verbs/Hide/{Key}/{Color}

export class Hide
{
    /** @description Key identifying a location */
    // @ApiMember(Description="Key identifying a location", IsRequired=true)
    public Key: string;

    /** @description HTML Color code (e.g. FF00FF) */
    // @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
    public Color: string;

    /** @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 to hide the position */
    // @ApiMember(Description="Optional: name of the stockroom where to hide the position")
    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<Hide>) { (Object as any).assign(this, init); }
}

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

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