| All Verbs | /ShowMultipleEx/{Color}/{Persistant} |
|---|
import Foundation
import ServiceStack
public class ShowMultipleEx : Codable
{
/**
* HTML Color code (e.g. FF00FF)
*/
// @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
public var color:String
/**
* 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 var persistant:Bool
/**
* List of key object (KeyToDisplay) to display
*/
// @ApiMember(Description="List of key object (KeyToDisplay) to display", IsRequired=true)
public var keys:[KeyToDisplay] = []
/**
* Optional: delay the execution of the command (in seconds)
*/
// @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
public var delay:Int?
/**
* Optional: duration of the show in seconds
*/
// @ApiMember(Description="Optional: duration of the show in seconds")
public var duration:Int?
/**
* 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
/**
* 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")
public var owner:String
required public init(){}
}
public class KeyToDisplay : Codable
{
/**
* Key identifying a location
*/
// @ApiMember(Description="Key identifying a location", IsRequired=true)
public var key:String
/**
* Blinking or not
*/
// @ApiMember(Description="Blinking or not", IsRequired=true)
public var blink:Bool
/**
* Indicates whether we show the area header of the blinking key or not
*/
// @ApiMember(Description="Indicates whether we show the area header of the blinking key or not", IsRequired=true)
public var showHeader:Bool
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ShowMultipleEx/{Color}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Color":"String","Persistant":false,"Keys":[{"Key":"String","Blink":false,"ShowHeader":false}],"Delay":0,"Duration":0,"StockroomName":"String","Owner":"String"}