| All Verbs | /ShowEffect/{Key}/{Color}/{Effect}/{Persistant} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | path | string | Yes | Key identifying a location |
| Effect | path | int | Yes | Animated effect selection: 0 = Always ON (no effect), 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Color | form | string | Yes | HTML Color code (e.g. FF00FF) |
| Persistant | form | bool | Yes | When set to false, it turns off the same color in a previous position |
| Delay | form | int? | No | Optional: delay the execution of the command (in seconds) |
| Duration | form | int? | No | Optional: duration of the show in seconds |
| StockroomName | form | string | No | Optional: name of the stockroom where to show the position |
| Owner | form | string | No | Optional: name of the owner of the color/command to allow color sharing |
| Unreliable | form | bool? | No | Optional: indicates if message shall be delivered in an unreliable way (faster) |
| DisplayHeader | form | bool? | No | Optional: indicates if the header shall be displayed |
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 /ShowEffect/{Key}/{Color}/{Effect}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowEffect xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Delay>0</Delay>
<DisplayHeader>false</DisplayHeader>
<Duration>0</Duration>
<Owner>String</Owner>
<Persistant>false</Persistant>
<StockroomName>String</StockroomName>
<Unreliable>false</Unreliable>
<Effect>0</Effect>
<Key>String</Key>
</ShowEffect>