| All Verbs | /ShowEffect/{Key}/{Color}/{Effect}/{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 ShowCommon
'''<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>
'''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 stockroom where to show the position
'''</Summary>
<ApiMember(Description:="Optional: name of the stockroom where to show the position")>
Public Overridable Property StockroomName As String
'''<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?
'''<Summary>
'''Optional: indicates if the header shall be displayed
'''</Summary>
<ApiMember(Description:="Optional: indicates if the header shall be displayed")>
Public Overridable Property DisplayHeader As Boolean?
End Class
Public Partial Class ShowEffect
Inherits ShowCommon
'''<Summary>
'''Key identifying a location
'''</Summary>
<ApiMember(Description:="Key identifying a location", IsRequired:=true)>
Public Overridable Property Key As String
'''<Summary>
'''Animated effect selection: 0 = Always ON (no effect), 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
'''</Summary>
<ApiMember(Description:="Animated effect selection: 0 = Always ON (no effect), 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", IsRequired:=true)>
Public Overridable Property Effect As Integer
End Class
End Namespace
End Namespace
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 /ShowEffect/{Key}/{Color}/{Effect}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Key":"String","Effect":0,"Color":"String","Persistant":false,"Delay":0,"Duration":0,"StockroomName":"String","Owner":"String","Unreliable":false,"DisplayHeader":false}