| All Verbs | /ShowOnAreaByName/{AreaName}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} |
|---|
namespace GoToLightAPI
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ShowOnAreaByName() =
///<summary>
///Area Name
///</summary>
[<ApiMember(Description="Area Name", IsRequired=true)>]
member val AreaName:String = null with get,set
///<summary>
///HTML Color code (e.g. FF00FF)
///</summary>
[<ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)>]
member val Color:String = null with get,set
///<summary>
///Pixel number on the area
///</summary>
[<ApiMember(Description="Pixel number on the area", IsRequired=true)>]
member val Pixel:Int32 = new Int32() with get,set
///<summary>
///Pixel width
///</summary>
[<ApiMember(Description="Pixel width", IsRequired=true)>]
member val Width:Int32 = new Int32() with get,set
///<summary>
///Blinking or not
///</summary>
[<ApiMember(Description="Blinking or not", IsRequired=true)>]
member val Blink:Boolean = new Boolean() with get,set
///<summary>
///When set to false, it turns off the same color in a previous position
///</summary>
[<ApiMember(Description="When set to false, it turns off the same color in a previous position", IsRequired=true)>]
member val Persistant:Boolean = new Boolean() with get,set
///<summary>
///Optional: delay the execution of the command (in seconds)
///</summary>
[<ApiMember(Description="Optional: delay the execution of the command (in seconds)")>]
member val Delay:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Optional: duration of the show in seconds
///</summary>
[<ApiMember(Description="Optional: duration of the show in seconds")>]
member val Duration:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Optional: name of the stockroom where the area is located
///</summary>
[<ApiMember(Description="Optional: name of the stockroom where the area is located")>]
member val StockroomName:String = null with get,set
///<summary>
///Optional: name of the owner of the color/command to allow color sharing
///</summary>
[<ApiMember(Description="Optional: name of the owner of the color/command to allow color sharing")>]
member val Owner:String = null with get,set
///<summary>
///Optional: indicates if message shall be delivered in an unreliable way (faster)
///</summary>
[<ApiMember(Description="Optional: indicates if message shall be delivered in an unreliable way (faster)")>]
member val Unreliable:Nullable<Boolean> = new Nullable<Boolean>() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ShowOnAreaByName/{AreaName}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"AreaName":"String","Color":"String","Pixel":0,"Width":0,"Blink":false,"Persistant":false,"Delay":0,"Duration":0,"StockroomName":"String","Owner":"String","Unreliable":false}