| All Verbs | /ShowEffect/{Key}/{Color}/{Effect}/{Persistant} |
|---|
export class ShowCommon
{
/** @description HTML Color code (e.g. FF00FF) */
// @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
public Color: string;
/** @description 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 Persistant: boolean;
/** @description Optional: delay the execution of the command (in seconds) */
// @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
public Delay?: number;
/** @description Optional: duration of the show in seconds */
// @ApiMember(Description="Optional: duration of the show in seconds")
public Duration?: number;
/** @description Optional: name of the stockroom where to show the position */
// @ApiMember(Description="Optional: name of the stockroom where to show the position")
public StockroomName: string;
/** @description 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 Owner: string;
/** @description 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 Unreliable?: boolean;
/** @description Optional: indicates if the header shall be displayed */
// @ApiMember(Description="Optional: indicates if the header shall be displayed")
public DisplayHeader?: boolean;
public constructor(init?: Partial<ShowCommon>) { (Object as any).assign(this, init); }
}
export class ShowEffect extends ShowCommon
{
/** @description Key identifying a location */
// @ApiMember(Description="Key identifying a location", IsRequired=true)
public Key: string;
/** @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 */
// @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 Effect: number;
public constructor(init?: Partial<ShowEffect>) { super(init); (Object as any).assign(this, init); }
}
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}