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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports GoToLightAPI

Namespace Global

    Namespace GoToLightAPI

        Public Partial Class PBL_StandardResponse
            Public Overridable Property Success As Boolean
            Public Overridable Property [Error] As String
            Public Overridable Property Result As Object
            Public Overridable Property Color As String
        End Class

        Public Partial Class PBL_SwitchOffPositions
            '''<Summary>
            '''Positions identifying LED locations
            '''</Summary>
            <ApiMember(Description:="Positions identifying LED locations", IsRequired:=true)>
            Public Overridable Property Positions As List(Of String) = New List(Of String)

            '''<Summary>
            '''Optional: HTML Color code (e.g. FF00FF)
            '''</Summary>
            <ApiMember(Description:="Optional: HTML Color code (e.g. FF00FF)")>
            Public Overridable Property Color As String

            '''<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")>
            Public Overridable Property Owner As String

            '''<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")>
            Public Overridable Property SwitchOffAnyColor As Boolean?
        End Class
    End Namespace
End Namespace

VB.NET PBL_SwitchOffPositions DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	Success: False,
	Error: String,
	Result: {},
	Color: String
}