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}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CCDeclareAndShowAlias
{
    /**
    * Key identifying a location
    */
    @ApiMember(Description="Key identifying a location", IsRequired=true)
    open var Key:String? = null

    /**
    * Business alias for this key
    */
    @ApiMember(Description="Business alias for this key", IsRequired=true)
    open var Alias:String? = null

    /**
    * 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
    */
    @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)
    open var Effect:Int? = null

    /**
    * HTML Color code (e.g. FF00FF)
    */
    @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
    open var Color:String? = null
}

Kotlin CCDeclareAndShowAlias DTOs

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

HTTP + JSV

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

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