| All Verbs | /ShowEffect/{Key}/{Color}/{Effect}/{Persistant} |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class ShowEffect : ShowCommon()
{
/**
* Key identifying a location
*/
@ApiMember(Description="Key identifying a location", IsRequired=true)
open var Key: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
}
open class ShowCommon
{
/**
* HTML Color code (e.g. FF00FF)
*/
@ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
open var Color:String? = 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 stockroom where to show the position
*/
@ApiMember(Description="Optional: name of the stockroom where to show the position")
open var StockroomName:String? = 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
/**
* Optional: indicates if the header shall be displayed
*/
@ApiMember(Description="Optional: indicates if the header shall be displayed")
open var DisplayHeader:Boolean? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ShowEffect/{Key}/{Color}/{Effect}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Key: String,
Effect: 0,
Color: String,
Persistant: False,
Delay: 0,
Duration: 0,
StockroomName: String,
Owner: String,
Unreliable: False,
DisplayHeader: False
}