| All Verbs | /PBL_ShowQuantity |
|---|
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 PBL_ShowQuantity
'''<Summary>
'''Position identifying a LED location
'''</Summary>
<ApiMember(Description:="Position identifying a LED location", IsRequired:=true)>
Public Overridable Property Position 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: Animated effect selection: 0 = Always ON (no effect, default), 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:="Optional: Animated effect selection: 0 = Always ON (no effect, default), 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?
'''<Summary>
'''Optional: HTML Color code (e.g. FF00FF)
'''</Summary>
<ApiMember(Description:="Optional: HTML Color code (e.g. FF00FF)")>
Public Overridable Property Color As String
'''<Summary>
'''Optional: When set to true, it turns off the same color in a previous position
'''</Summary>
<ApiMember(Description:="Optional: When set to true, it turns off the same color in a previous position")>
Public Overridable Property HidePreviousPosition As Boolean?
'''<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
End Class
Public Partial Class PBL_StandardResponse
Public Overridable Property Success As Boolean
Public Overridable Property [Error] As String
Public Overridable Property Result As Object
Public Overridable Property Color 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 /PBL_ShowQuantity HTTP/1.1
Host: clouddemo.pickeos.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PBL_ShowQuantity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Color>String</Color>
<Effect>0</Effect>
<HidePreviousPosition>false</HidePreviousPosition>
<Owner>String</Owner>
<Position>String</Position>
<Quantity>0</Quantity>
</PBL_ShowQuantity>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <PBL_StandardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI"> <Color>String</Color> <Error>String</Error> <Result /> <Success>false</Success> </PBL_StandardResponse>