Go-to-Light Service 4.0.0.2397 - 121 - API License to Cloud Demo

<back to all web services

ShowOnLedControllerEx

Requires Authentication
The following routes are available for this service:
All Verbs/ShowOnLedControllerEx/{LCAddress}/{Color}/{Pixel}/{Width}/{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 ShowOnLedControllerEx
            '''<Summary>
            '''Led Controller Address
            '''</Summary>
            <ApiMember(Description:="Led Controller Address", IsRequired:=true)>
            Public Overridable Property LCAddress 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
            '''</Summary>
            <ApiMember(Description:="Pixel number", 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>
            '''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?

            '''<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

VB.NET ShowOnLedControllerEx DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /ShowOnLedControllerEx/{LCAddress}/{Color}/{Pixel}/{Width}/{Effect}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"LCAddress":"String","Color":"String","Pixel":0,"Width":0,"Effect":0,"Persistant":false,"Delay":0,"Duration":0,"StockroomName":"String","Owner":"String","Unreliable":false}