| All Verbs | /ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} |
|---|
import Foundation
import ServiceStack
public class ShowOnArea : Codable
{
/**
* Area ID
*/
// @ApiMember(Description="Area ID", IsRequired=true)
public var areaID:Int
/**
* HTML Color code (e.g. FF00FF)
*/
// @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
public var color:String
/**
* Pixel number on the area
*/
// @ApiMember(Description="Pixel number on the area", IsRequired=true)
public var pixel:Int
/**
* Pixel width
*/
// @ApiMember(Description="Pixel width", IsRequired=true)
public var width:Int
/**
* Blinking or not
*/
// @ApiMember(Description="Blinking or not", IsRequired=true)
public var blink:Bool
/**
* 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
/**
* 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 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: indicates if message shall be delivered in an unreliable way (faster)
*/
// @ApiMember(Description="Optional: indicates if message shall be delivered in an unreliable way (faster)")
public var unreliable:Bool?
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 /ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowOnArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<AreaID>0</AreaID>
<Blink>false</Blink>
<Color>String</Color>
<Delay>0</Delay>
<Duration>0</Duration>
<Owner>String</Owner>
<Persistant>false</Persistant>
<Pixel>0</Pixel>
<Unreliable>false</Unreliable>
<Width>0</Width>
</ShowOnArea>