| All Verbs | /ShowOnAreaByName/{AreaName}/{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 ShowOnAreaByName
'''<Summary>
'''Area Name
'''</Summary>
<ApiMember(Description:="Area Name", IsRequired:=true)>
Public Overridable Property AreaName As String
'''<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 stockroom where the area is located
'''</Summary>
<ApiMember(Description:="Optional: name of the stockroom where the area is located")>
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?
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 /ShowOnAreaByName/{AreaName}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ShowOnAreaByName xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<AreaName>String</AreaName>
<Blink>false</Blink>
<Color>String</Color>
<Delay>0</Delay>
<Duration>0</Duration>
<Owner>String</Owner>
<Persistant>false</Persistant>
<Pixel>0</Pixel>
<StockroomName>String</StockroomName>
<Unreliable>false</Unreliable>
<Width>0</Width>
</ShowOnAreaByName>