| All Verbs | /ShowMultipleEx/{Color}/{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 KeyToDisplay
'''<Summary>
'''Key identifying a location
'''</Summary>
<ApiMember(Description:="Key identifying a location", IsRequired:=true)>
Public Overridable Property Key As String
'''<Summary>
'''Blinking or not
'''</Summary>
<ApiMember(Description:="Blinking or not", IsRequired:=true)>
Public Overridable Property Blink As Boolean
'''<Summary>
'''Indicates whether we show the area header of the blinking key or not
'''</Summary>
<ApiMember(Description:="Indicates whether we show the area header of the blinking key or not", IsRequired:=true)>
Public Overridable Property ShowHeader As Boolean
End Class
Public Partial Class ShowMultipleEx
'''<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>
'''List of key object (KeyToDisplay) to display
'''</Summary>
<ApiMember(Description:="List of key object (KeyToDisplay) to display", IsRequired:=true)>
Public Overridable Property Keys As List(Of KeyToDisplay) = New List(Of KeyToDisplay)
'''<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>
'''Name of the owner of the color/command to allow color sharing
'''</Summary>
<ApiMember(Description:="Name of the owner of the color/command to allow color sharing")>
Public Overridable Property Owner As String
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 /ShowMultipleEx/{Color}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowMultipleEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Delay>0</Delay>
<Duration>0</Duration>
<Keys>
<KeyToDisplay>
<Blink>false</Blink>
<Key>String</Key>
<ShowHeader>false</ShowHeader>
</KeyToDisplay>
</Keys>
<Owner>String</Owner>
<Persistant>false</Persistant>
<StockroomName>String</StockroomName>
</ShowMultipleEx>