Go-to-Light Service 4.0.0.2397 - 121 - API License to Cloud Demo

<back to all web services

CCDeclareAndShowAlias

Requires Authentication
The following routes are available for this service:
All Verbs/CCDeclareAndShowAlias/{Key}/{Alias}/{Color}/{Effect}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports GoToLightAPI

Namespace Global

    Namespace GoToLightAPI

        Public Partial Class CCDeclareAndShowAlias
            '''<Summary>
            '''Key identifying a location
            '''</Summary>
            <ApiMember(Description:="Key identifying a location", IsRequired:=true)>
            Public Overridable Property Key As String

            '''<Summary>
            '''Business alias for this key
            '''</Summary>
            <ApiMember(Description:="Business alias for this key", IsRequired:=true)>
            Public Overridable Property [Alias] As String

            '''<Summary>
            '''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
            '''</Summary>
            <ApiMember(Description:="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", IsRequired:=true)>
            Public Overridable Property Effect As Integer

            '''<Summary>
            '''HTML Color code (e.g. FF00FF)
            '''</Summary>
            <ApiMember(Description:="HTML Color code (e.g. FF00FF)", IsRequired:=true)>
            Public Overridable Property Color As String
        End Class
    End Namespace
End Namespace

VB.NET CCDeclareAndShowAlias DTOs

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

HTTP + 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>