| All Verbs | /ShowPredictive/{BlinkKey}/{SteadyKey}/{Color}/{ShowHeader}/{Owner} |
|---|
import Foundation
import ServiceStack
public class ShowPredictive : Codable
{
/**
* Key identifying a location that will be shown blinking
*/
// @ApiMember(Description="Key identifying a location that will be shown blinking", IsRequired=true)
public var blinkKey:String
/**
* 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 var steadyKey:String
/**
* HTML Color code (e.g. FF00FF)
*/
// @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
public var color:String
/**
* 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 var showHeader:HeaderMode
/**
* 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 var owner:String
/**
* Optional: name of the stockroom where to show the position
*/
// @ApiMember(Description="Optional: name of the stockroom where to show the position")
public var stockroomName:String
required public init(){}
}
public enum HeaderMode : String, Codable
{
case on
case off
case once
}
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 /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
}