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

<back to all web services

PBL_SwitchOffPosition

Requires Authentication
The following routes are available for this service:
All Verbs/PBL_SwitchOffPosition
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_SwitchOffPosition() = 
        ///<summary>
        ///Position identifying a LED location
        ///</summary>
        [<ApiMember(Description="Position identifying a LED location", IsRequired=true)>]
        member val Position: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 position
        ///</summary>
        [<ApiMember(Description="Optional: set paramter to TRUE if you need to turn off any color previously turned ON at specified position")>]
        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_SwitchOffPosition 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 /PBL_SwitchOffPosition HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PBL_SwitchOffPosition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Owner>String</Owner>
  <Position>String</Position>
  <SwitchOffAnyColor>false</SwitchOffAnyColor>
</PBL_SwitchOffPosition>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PBL_StandardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Error>String</Error>
  <Result />
  <Success>false</Success>
</PBL_StandardResponse>