Go-to-Light Service 3.1.1.1547 - 97 - API License to GTL Cloud

<back to all web services

PBL_SwitchOffPosition

Requires Authentication
The following routes are available for this service:
All Verbs/PBL_SwitchOffPosition
PBL_SwitchOffPosition Parameters:
NameParameterData TypeRequiredDescription
PositionquerystringYesPosition identifying a LED location
ColorquerystringNoOptional: HTML Color code (e.g. FF00FF)
OwnerquerystringNoOptional: name of the owner of the color/command to allow color sharing
PBL_StandardResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
ErrorformstringNo
ResultformObjectNo
ColorformstringNo

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_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>
</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 xmlns:d2p1="http://www.w3.org/2001/XMLSchema" i:type="d2p1:anyType" />
  <Success>false</Success>
</PBL_StandardResponse>