| All Verbs | /PBL_ShowQuantities |
|---|
import Foundation
import ServiceStack
public class PBL_ShowQuantities : Codable
{
/**
* Positions identifying the LED locations
*/
// @ApiMember(Description="Positions identifying the LED locations", IsRequired=true)
public var positions:[String] = []
/**
* Quantities: Number of LED to show corresponding to each position
*/
// @ApiMember(Description="Quantities: Number of LED to show corresponding to each position", IsRequired=true)
public var quantities:[Int] = []
/**
* Optional: Animated effect selection: 0 = Always ON (no effect, default), 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="Optional: Animated effect selection: 0 = Always ON (no effect, default), 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")
public var effect:Int?
/**
* Optional: HTML Color code (e.g. FF00FF)
*/
// @ApiMember(Description="Optional: HTML Color code (e.g. FF00FF)")
public var color:String
/**
* Optional: When set to true, it turns off the same color in a previous position
*/
// @ApiMember(Description="Optional: When set to true, it turns off the same color in a previous position")
public var hidePreviousPosition:Bool?
/**
* 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 var owner:String
/**
* Optional: name of the stockroom where the positions are located
*/
// @ApiMember(Description="Optional: name of the stockroom where the positions are located")
public var stockroomName:String
required public init(){}
}
public class PBL_StandardResponse : Codable
{
public var success:Bool
public var error:String
public var result:String
public var color:String
required public init(){}
}
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 /PBL_ShowQuantities HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Positions:
[
String
],
Quantities:
[
0
],
Effect: 0,
Color: String,
HidePreviousPosition: False,
Owner: String,
StockroomName: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Success: False,
Error: String,
Result: {},
Color: String
}