| All Verbs | /CCDeclareAndShowAlias/{Key}/{Alias}/{Color}/{Effect} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | path | string | Yes | Key identifying a location |
| Alias | path | string | Yes | Business alias for this key |
| 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 |
| Color | path | string | Yes | HTML Color code (e.g. FF00FF) |
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 /CCDeclareAndShowAlias/{Key}/{Alias}/{Color}/{Effect} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CCDeclareAndShowAlias xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Alias>String</Alias>
<Color>String</Color>
<Effect>0</Effect>
<Key>String</Key>
</CCDeclareAndShowAlias>