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

<back to all web services

Show

Requires Authentication
The following routes are available for this service:
All Verbs/Show/{Key}/{Color}/{Blink}/{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 ShowCommon() = 
        ///<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>
        ///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 to show the position
        ///</summary>
        [<ApiMember(Description="Optional: name of the stockroom where to show the position")>]
        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

        ///<summary>
        ///Optional: indicates if the header shall be displayed
        ///</summary>
        [<ApiMember(Description="Optional: indicates if the header shall be displayed")>]
        member val DisplayHeader:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AllowNullLiteral>]
    type Show() = 
        inherit ShowCommon()
        ///<summary>
        ///Key identifying a location
        ///</summary>
        [<ApiMember(Description="Key identifying a location", IsRequired=true)>]
        member val Key:String = null with get,set

        ///<summary>
        ///Blinking or not
        ///</summary>
        [<ApiMember(Description="Blinking or not", IsRequired=true)>]
        member val Blink:Boolean = new Boolean() with get,set

F# Show 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 /Show/{Key}/{Color}/{Blink}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Key":"String","Blink":false,"Color":"String","Persistant":false,"Delay":0,"Duration":0,"StockroomName":"String","Owner":"String","Unreliable":false,"DisplayHeader":false}