Go-to-Light Service 3.1.1.1547 - 97 - API License to GTL Cloud

<back to all web services

CCDeclareAndShowAlias

Requires Authentication
The following routes are available for this service:
All Verbs/CCDeclareAndShowAlias/{Key}/{Alias}/{Color}/{Effect}
CCDeclareAndShowAlias Parameters:
NameParameterData TypeRequiredDescription
KeypathstringYesKey identifying a location
AliaspathstringYesBusiness alias for this key
EffectpathintYesAnimated 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
ColorpathstringYesHTML Color code (e.g. FF00FF)

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"Key":"String","Alias":"String","Effect":0,"Color":"String"}