| All Verbs | /PBL_ShowQuantity |
|---|
import Foundation
import ServiceStack
public class PBL_ShowQuantity : Codable
{
/**
* Position identifying a LED location
*/
// @ApiMember(Description="Position identifying a LED location", IsRequired=true)
public var position:String
/**
* Quantity: Number of LED to show
*/
// @ApiMember(Description="Quantity: Number of LED to show", IsRequired=true)
public var quantity: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
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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /PBL_ShowQuantity HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PBL_ShowQuantity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Effect>0</Effect>
<HidePreviousPosition>false</HidePreviousPosition>
<Owner>String</Owner>
<Position>String</Position>
<Quantity>0</Quantity>
</PBL_ShowQuantity>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <PBL_StandardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI"> <Color>String</Color> <Error>String</Error> <Result /> <Success>false</Success> </PBL_StandardResponse>