| All Verbs | /ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports GoToLightAPI
Namespace Global
Namespace GoToLightAPI
Public Partial Class ShowOnArea
'''<Summary>
'''Area ID
'''</Summary>
<ApiMember(Description:="Area ID", IsRequired:=true)>
Public Overridable Property AreaID As Integer
'''<Summary>
'''HTML Color code (e.g. FF00FF)
'''</Summary>
<ApiMember(Description:="HTML Color code (e.g. FF00FF)", IsRequired:=true)>
Public Overridable Property Color As String
'''<Summary>
'''Pixel number on the area
'''</Summary>
<ApiMember(Description:="Pixel number on the area", IsRequired:=true)>
Public Overridable Property Pixel As Integer
'''<Summary>
'''Pixel width
'''</Summary>
<ApiMember(Description:="Pixel width", IsRequired:=true)>
Public Overridable Property Width As Integer
'''<Summary>
'''Blinking or not
'''</Summary>
<ApiMember(Description:="Blinking or not", IsRequired:=true)>
Public Overridable Property Blink As Boolean
'''<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)>
Public Overridable Property Persistant As Boolean
'''<Summary>
'''Optional: delay the execution of the command (in seconds)
'''</Summary>
<ApiMember(Description:="Optional: delay the execution of the command (in seconds)")>
Public Overridable Property Delay As Integer?
'''<Summary>
'''Optional: duration of the show in seconds
'''</Summary>
<ApiMember(Description:="Optional: duration of the show in seconds")>
Public Overridable Property Duration As Integer?
'''<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")>
Public Overridable Property Owner As String
'''<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)")>
Public Overridable Property Unreliable As Boolean?
End Class
End Namespace
End Namespace
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 /ShowOnArea/{AreaID}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AreaID: 0,
Color: String,
Pixel: 0,
Width: 0,
Blink: False,
Persistant: False,
Delay: 0,
Duration: 0,
Owner: String,
Unreliable: False
}