| All Verbs | /ShowQuantity/{Key}/{Color}/{Quantity}/{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 ShowQuantity
Inherits ShowCommon
'''<Summary>
'''Key identifying a location
'''</Summary>
<ApiMember(Description:="Key identifying a location", IsRequired:=true)>
Public Overridable Property Key As String
'''<Summary>
'''Quantity: number of LED to show
'''</Summary>
<ApiMember(Description:="Quantity: number of LED to show", IsRequired:=true)>
Public Overridable Property Quantity As Integer
'''<Summary>
'''Optional: Force blinking
'''</Summary>
<ApiMember(Description:="Optional: Force blinking")>
Public Overridable Property ForceBlink As Boolean?
'''<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")>
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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ShowQuantity/{Key}/{Color}/{Quantity}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowQuantity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Delay>0</Delay>
<DisplayHeader>false</DisplayHeader>
<Duration>0</Duration>
<Owner>String</Owner>
<Persistant>false</Persistant>
<StockroomName>String</StockroomName>
<Unreliable>false</Unreliable>
<Effect>0</Effect>
<ForceBlink>false</ForceBlink>
<Key>String</Key>
<Quantity>0</Quantity>
</ShowQuantity>