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

<back to all web services

PBL_SetFreePosition

Requires Authentication
The following routes are available for this service:
All Verbs/PBL_SetFreePosition/{Key}/{LCAddress}/{PixelBegin}/{PixelEnd}/{OutputNumber}
PBL_SetFreePosition Parameters:
NameParameterData TypeRequiredDescription
KeypathstringYesKey identifying a location
LCAddresspathstringYesLCAddress
PixelBeginpathintYesNumber of first pixel
PixelEndpathintYesNumber of last pixel
OutputNumberpathintYesOutput number
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_SetFreePosition/{Key}/{LCAddress}/{PixelBegin}/{PixelEnd}/{OutputNumber} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PBL_SetFreePosition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Key>String</Key>
  <LCAddress>String</LCAddress>
  <OutputNumber>0</OutputNumber>
  <PixelBegin>0</PixelBegin>
  <PixelEnd>0</PixelEnd>
</PBL_SetFreePosition>
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>