| All Verbs | /ShowEffect/{Key}/{Color}/{Effect}/{Persistant} |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class ShowEffect extends ShowCommon
{
/**
* Key identifying a location
*/
@ApiMember(Description="Key identifying a location", IsRequired=true)
public String Key = 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)
public Integer Effect = null;
public String getKey() { return Key; }
public ShowEffect setKey(String value) { this.Key = value; return this; }
public Integer getEffect() { return Effect; }
public ShowEffect setEffect(Integer value) { this.Effect = value; return this; }
}
public static class ShowCommon
{
/**
* HTML Color code (e.g. FF00FF)
*/
@ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
public String Color = 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)
public Boolean Persistant = null;
/**
* Optional: delay the execution of the command (in seconds)
*/
@ApiMember(Description="Optional: delay the execution of the command (in seconds)")
public Integer Delay = null;
/**
* Optional: duration of the show in seconds
*/
@ApiMember(Description="Optional: duration of the show in seconds")
public Integer Duration = null;
/**
* Optional: name of the stockroom where to show the position
*/
@ApiMember(Description="Optional: name of the stockroom where to show the position")
public String StockroomName = 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")
public String Owner = 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)")
public Boolean Unreliable = null;
/**
* Optional: indicates if the header shall be displayed
*/
@ApiMember(Description="Optional: indicates if the header shall be displayed")
public Boolean DisplayHeader = null;
public String getColor() { return Color; }
public ShowCommon setColor(String value) { this.Color = value; return this; }
public Boolean isPersistant() { return Persistant; }
public ShowCommon setPersistant(Boolean value) { this.Persistant = value; return this; }
public Integer getDelay() { return Delay; }
public ShowCommon setDelay(Integer value) { this.Delay = value; return this; }
public Integer getDuration() { return Duration; }
public ShowCommon setDuration(Integer value) { this.Duration = value; return this; }
public String getStockroomName() { return StockroomName; }
public ShowCommon setStockroomName(String value) { this.StockroomName = value; return this; }
public String getOwner() { return Owner; }
public ShowCommon setOwner(String value) { this.Owner = value; return this; }
public Boolean isUnreliable() { return Unreliable; }
public ShowCommon setUnreliable(Boolean value) { this.Unreliable = value; return this; }
public Boolean isDisplayHeader() { return DisplayHeader; }
public ShowCommon setDisplayHeader(Boolean value) { this.DisplayHeader = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Key":"String","Effect":0,"Color":"String","Persistant":false,"Delay":0,"Duration":0,"StockroomName":"String","Owner":"String","Unreliable":false,"DisplayHeader":false}