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

<back to all web services

PBL_SwitchOffPositions

Requires Authentication
The following routes are available for this service:
All Verbs/PBL_SwitchOffPositions
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 PBL_SwitchOffPositions() = 
        ///<summary>
        ///Positions identifying LED locations
        ///</summary>
        [<ApiMember(Description="Positions identifying LED locations", IsRequired=true)>]
        member val Positions:ResizeArray<String> = null with get,set

        ///<summary>
        ///Optional: HTML Color code (e.g. FF00FF)
        ///</summary>
        [<ApiMember(Description="Optional: HTML Color code (e.g. FF00FF)")>]
        member val Color: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: set paramter to TRUE if you need to turn off any color previously turned ON at specified positions
        ///</summary>
        [<ApiMember(Description="Optional: set paramter to TRUE if you need to turn off any color previously turned ON at specified positions")>]
        member val SwitchOffAnyColor:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AllowNullLiteral>]
    type PBL_StandardResponse() = 
        member val Success:Boolean = new Boolean() with get,set
        member val Error:String = null with get,set
        member val Result:Object = null with get,set
        member val Color:String = null with get,set

F# PBL_SwitchOffPositions DTOs

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

HTTP + OTHER

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

POST /PBL_SwitchOffPositions HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Positions":["String"],"Color":"String","Owner":"String","SwitchOffAnyColor":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Success":false,"Error":"String","Result":{},"Color":"String"}