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

<back to all web services

ShowPredictive

Requires Authentication
The following routes are available for this service:
All Verbs/ShowPredictive/{BlinkKey}/{SteadyKey}/{Color}/{ShowHeader}/{Owner}

export enum HeaderMode
{
    on = 'on',
    off = 'off',
    once = 'once',
}

export class ShowPredictive
{
    /** @description Key identifying a location that will be shown blinking */
    // @ApiMember(Description="Key identifying a location that will be shown blinking", IsRequired=true)
    public BlinkKey: string;

    /** @description Key identifying a location that will be shown not blinking */
    // @ApiMember(Description="Key identifying a location that will be shown not blinking", IsRequired=true)
    public SteadyKey: string;

    /** @description HTML Color code (e.g. FF00FF) */
    // @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
    public Color: string;

    /** @description Indicates the way the area header will be displayed (possible values are on, off, once) */
    // @ApiMember(Description="Indicates the way the area header will be displayed (possible values are on, off, once)", IsRequired=true)
    public ShowHeader: HeaderMode;

    /** @description Name of the owner of the color/command to allow color sharing */
    // @ApiMember(Description="Name of the owner of the color/command to allow color sharing", IsRequired=true)
    public Owner: string;

    /** @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;

    public constructor(init?: Partial<ShowPredictive>) { (Object as any).assign(this, init); }
}

TypeScript ShowPredictive 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 /ShowPredictive/{BlinkKey}/{SteadyKey}/{Color}/{ShowHeader}/{Owner} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	BlinkKey: String,
	SteadyKey: String,
	Color: String,
	ShowHeader: on,
	Owner: String,
	StockroomName: String
}