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

<back to all web services

ShowOnArea

Requires Authentication
The following routes are available for this service:
All Verbs/ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class ShowOnArea
{
    /**
    * Area ID
    */
    @ApiMember(Description="Area ID", IsRequired=true)
    open var AreaID:Int? = null

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

    /**
    * Pixel number on the area
    */
    @ApiMember(Description="Pixel number on the area", IsRequired=true)
    open var Pixel:Int? = null

    /**
    * Pixel width
    */
    @ApiMember(Description="Pixel width", IsRequired=true)
    open var Width:Int? = null

    /**
    * Blinking or not
    */
    @ApiMember(Description="Blinking or not", IsRequired=true)
    open var Blink:Boolean? = null

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

    /**
    * Optional: delay the execution of the command (in seconds)
    */
    @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
    open var Delay:Int? = null

    /**
    * Optional: duration of the show in seconds
    */
    @ApiMember(Description="Optional: duration of the show in seconds")
    open var Duration:Int? = 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: indicates if message shall be delivered in an unreliable way (faster)
    */
    @ApiMember(Description="Optional: indicates if message shall be delivered in an unreliable way (faster)")
    open var Unreliable:Boolean? = null
}

Kotlin ShowOnArea DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AreaID":0,"Color":"String","Pixel":0,"Width":0,"Blink":false,"Persistant":false,"Delay":0,"Duration":0,"Owner":"String","Unreliable":false}