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

<back to all web services

ShowArea

Requires Authentication
The following routes are available for this service:
All Verbs/ShowArea/{AreaID}/{ColorStart}/{ColorStop}/{Duration}
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 ShowArea() = 
        ///<summary>
        ///Area ID
        ///</summary>
        [<ApiMember(Description="Area ID", IsRequired=true)>]
        member val AreaID:Int32 = new Int32() with get,set

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

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

        ///<summary>
        ///Duration in seconds
        ///</summary>
        [<ApiMember(Description="Duration in seconds", IsRequired=true)>]
        member val Duration:Int32 = new Int32() 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

F# ShowArea 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 /ShowArea/{AreaID}/{ColorStart}/{ColorStop}/{Duration} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AreaID":0,"ColorStart":"String","ColorStop":"String","Duration":0,"Owner":"String"}