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

<back to all web services

HideOnAreaByName

Requires Authentication
The following routes are available for this service:
All Verbs/HideOnAreaByName/{AreaName}/{Color}/{Pixel}
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 HideOnAreaByName() = 
        ///<summary>
        ///Area Name
        ///</summary>
        [<ApiMember(Description="Area Name", IsRequired=true)>]
        member val AreaName: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 on the group
        ///</summary>
        [<ApiMember(Description="Pixel number on the group", IsRequired=true)>]
        member val Pixel:Int32 = new Int32() 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: 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

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

{"AreaName":"String","Color":"String","Pixel":0,"Delay":0,"StockroomName":"String","Owner":"String"}