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

<back to all web services

PBL_SwitchOffPosition

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

export class PBL_SwitchOffPosition
{
    /** @description Position identifying a LED location */
    // @ApiMember(Description="Position identifying a LED location", IsRequired=true)
    public Position: 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 position */
    // @ApiMember(Description="Optional: set paramter to TRUE if you need to turn off any color previously turned ON at specified position")
    public SwitchOffAnyColor?: boolean;

    public constructor(init?: Partial<PBL_SwitchOffPosition>) { (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_SwitchOffPosition DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /PBL_SwitchOffPosition HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Position":"String","Color":"String","Owner":"String","SwitchOffAnyColor":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Success":false,"Error":"String","Result":{},"Color":"String"}