| All Verbs | /ShowOnAreaByName/{AreaName}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AreaName | path | string | Yes | Area Name |
| Color | path | string | Yes | HTML Color code (e.g. FF00FF) |
| Pixel | path | int | Yes | Pixel number on the area |
| Width | path | int | Yes | Pixel width |
| Blink | path | bool | Yes | Blinking or not |
| Persistant | path | bool | Yes | When set to false, it turns off the same color in a previous position |
| Delay | query | int? | No | Optional: delay the execution of the command (in seconds) |
| Duration | query | int? | No | Optional: duration of the show in seconds |
| StockroomName | query | string | No | Optional: name of the stockroom where the area is located |
| Owner | query | string | No | Optional: name of the owner of the color/command to allow color sharing |
| Unreliable | query | bool? | No | Optional: indicates if message shall be delivered in an unreliable way (faster) |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ShowOnAreaByName/{AreaName}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"AreaName":"String","Color":"String","Pixel":0,"Width":0,"Blink":false,"Persistant":false,"Delay":0,"Duration":0,"StockroomName":"String","Owner":"String","Unreliable":false}