| All Verbs | /ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class ShowOnArea
{
/**
* Area ID
*/
@ApiMember(Description="Area ID", IsRequired=true)
open var AreaID:Int? = null
/**
* HTML Color code (e.g. FF00FF)
*/
@ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
open var Color:String? = null
/**
* Pixel number on the area
*/
@ApiMember(Description="Pixel number on the area", IsRequired=true)
open var Pixel:Int? = null
/**
* Pixel width
*/
@ApiMember(Description="Pixel width", IsRequired=true)
open var Width:Int? = null
/**
* Blinking or not
*/
@ApiMember(Description="Blinking or not", IsRequired=true)
open var Blink:Boolean? = null
/**
* 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)
open var Persistant:Boolean? = null
/**
* Optional: delay the execution of the command (in seconds)
*/
@ApiMember(Description="Optional: delay the execution of the command (in seconds)")
open var Delay:Int? = null
/**
* Optional: duration of the show in seconds
*/
@ApiMember(Description="Optional: duration of the show in seconds")
open var Duration:Int? = null
/**
* 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")
open var Owner:String? = null
/**
* 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)")
open var Unreliable:Boolean? = null
}
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>