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

<back to all web services

PBL_SwitchOffPositions

Requires Authentication
The following routes are available for this service:
All Verbs/PBL_SwitchOffPositions

export class PBL_SwitchOffPositions
{
    /** @description Positions identifying LED locations */
    // @ApiMember(Description="Positions identifying LED locations", IsRequired=true)
    public Positions: string[] = [];

    /** @description Optional: HTML Color code (e.g. FF00FF) */
    // @ApiMember(Description="Optional: HTML Color code (e.g. FF00FF)")
    public Color: 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;

    /** @description Optional: set paramter to TRUE if you need to turn off any color previously turned ON at specified positions */
    // @ApiMember(Description="Optional: set paramter to TRUE if you need to turn off any color previously turned ON at specified positions")
    public SwitchOffAnyColor?: boolean;

    public constructor(init?: Partial<PBL_SwitchOffPositions>) { (Object as any).assign(this, init); }
}

export class PBL_StandardResponse
{
    public Success: boolean;
    public Error: string;
    public Result: Object;
    public Color: string;

    public constructor(init?: Partial<PBL_StandardResponse>) { (Object as any).assign(this, init); }
}

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

<PBL_SwitchOffPositions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Owner>String</Owner>
  <Positions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Positions>
  <SwitchOffAnyColor>false</SwitchOffAnyColor>
</PBL_SwitchOffPositions>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PBL_StandardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Error>String</Error>
  <Result />
  <Success>false</Success>
</PBL_StandardResponse>