| All Verbs | /PBL_ShowQuantity |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Position | query | string | Yes | Position identifying a LED location |
| Quantity | query | int | Yes | Quantity: Number of LED to show |
| Effect | query | int? | No | Optional: Animated effect selection: 0 = Always ON (no effect, default), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW |
| Color | query | string | No | Optional: HTML Color code (e.g. FF00FF) |
| HidePreviousPosition | query | bool? | No | Optional: When set to true, it turns off the same color in a previous position |
| Owner | query | string | No | Optional: Name of the owner of the color/command to allow color sharing |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| Error | form | string | No | |
| Result | form | Object | No | |
| Color | form | string | No |
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_ShowQuantity HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PBL_ShowQuantity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Effect>0</Effect>
<HidePreviousPosition>false</HidePreviousPosition>
<Owner>String</Owner>
<Position>String</Position>
<Quantity>0</Quantity>
</PBL_ShowQuantity>
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>