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}
namespace GoToLightAPI

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ShowOnLedControllerEx() = 
        ///<summary>
        ///Led Controller Address
        ///</summary>
        [<ApiMember(Description="Led Controller Address", IsRequired=true)>]
        member val LCAddress:String = null with get,set

        ///<summary>
        ///HTML Color code (e.g. FF00FF)
        ///</summary>
        [<ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)>]
        member val Color:String = null with get,set

        ///<summary>
        ///Pixel number
        ///</summary>
        [<ApiMember(Description="Pixel number", IsRequired=true)>]
        member val Pixel:Int32 = new Int32() with get,set

        ///<summary>
        ///Pixel width
        ///</summary>
        [<ApiMember(Description="Pixel width", IsRequired=true)>]
        member val Width:Int32 = new Int32() with get,set

        ///<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)>]
        member val Effect:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<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)>]
        member val Persistant:Boolean = new Boolean() with get,set

        ///<summary>
        ///Optional: delay the execution of the command (in seconds)
        ///</summary>
        [<ApiMember(Description="Optional: delay the execution of the command (in seconds)")>]
        member val Delay:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Optional: duration of the show in seconds
        ///</summary>
        [<ApiMember(Description="Optional: duration of the show in seconds")>]
        member val Duration:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Optional: name of the stockroom where the area is located
        ///</summary>
        [<ApiMember(Description="Optional: name of the stockroom where the area is located")>]
        member val StockroomName:String = null with get,set

        ///<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")>]
        member val Owner:String = null with get,set

        ///<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)")>]
        member val Unreliable:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# ShowOnLedControllerEx DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<ShowOnLedControllerEx 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>
  <Effect>0</Effect>
  <LCAddress>String</LCAddress>
  <Owner>String</Owner>
  <Persistant>false</Persistant>
  <Pixel>0</Pixel>
  <StockroomName>String</StockroomName>
  <Unreliable>false</Unreliable>
  <Width>0</Width>
</ShowOnLedControllerEx>