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

<back to all web services

PBL_SwitchOnPosition

Requires Authentication
The following routes are available for this service:
All Verbs/PBL_SwitchOnPosition
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

    /**
    * Optional: Animated effect selection: 0 = Always ON (no effect, default), 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="Optional: Animated effect selection: 0 = Always ON (no effect, default), 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")
    open var Effect:Int? = null

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

    /**
    * Optional: When set to true, it turns off the same color in a previous position
    */
    @ApiMember(Description="Optional: When set to true, it turns off the same color in a previous position")
    open var HidePreviousPosition:Boolean? = null

    /**
    * Optional: name of the owner of the color/command to allow color sharing
    */
    @ApiMember(Description="Optional: name of the owner of the color/command to allow color sharing")
    open var Owner:String? = null

    /**
    * Optional: duration of the show in seconds
    */
    @ApiMember(Description="Optional: duration of the show in seconds")
    open var Duration:Int? = null
}

open class PBL_StandardResponse
{
    open var Success:Boolean? = null
    open var Error:String? = null
    open var Result:Object? = null
    open var Color:String? = null
}

Kotlin PBL_SwitchOnPosition 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 /PBL_SwitchOnPosition HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Position: String,
	Effect: 0,
	Color: String,
	HidePreviousPosition: False,
	Owner: String,
	Duration: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Error: String,
	Result: {},
	Color: String
}