| All Verbs | /ShowMultipleEx/{Color}/{Persistant} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Color | path | string | Yes | HTML Color code (e.g. FF00FF) |
| Persistant | path | bool | Yes | When set to false, it turns off the same color in a previous position |
| Keys | query | List<KeyToDisplay> | Yes | List of key object (KeyToDisplay) to display |
| 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 to show the position |
| Owner | query | string | No | Name of the owner of the color/command to allow color sharing |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | form | string | Yes | Key identifying a location |
| Blink | form | bool | Yes | Blinking or not |
| ShowHeader | form | bool | Yes | Indicates whether we show the area header of the blinking key or not |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ShowMultipleEx/{Color}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Color: String,
Persistant: False,
Keys:
[
{
Key: String,
Blink: False,
ShowHeader: False
}
],
Delay: 0,
Duration: 0,
StockroomName: String,
Owner: String
}