| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<PBL_SwitchOffPosition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Owner>String</Owner>
<Position>String</Position>
<SwitchOffAnyColor>false</SwitchOffAnyColor>
</PBL_SwitchOffPosition>
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>