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

<back to all web services

HideColorOnAreaByName

Requires Authentication
The following routes are available for this service:
All Verbs/HideColorOnAreaByName/{AreaName}/{Color}
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 HideColorOnAreaByName
            '''<Summary>
            '''Area Name
            '''</Summary>
            <ApiMember(Description:="Area Name", IsRequired:=true)>
            Public Overridable Property AreaName As String

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

            '''<Summary>
            '''Optional: delay the execution of the command (in seconds)
            '''</Summary>
            <ApiMember(Description:="Optional: delay the execution of the command (in seconds)")>
            Public Overridable Property Delay As Integer?

            '''<Summary>
            '''Optional: name of the stockroom where the area is located
            '''</Summary>
            <ApiMember(Description:="Optional: name of the stockroom where the area is located")>
            Public Overridable Property StockroomName 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
        End Class
    End Namespace
End Namespace

VB.NET HideColorOnAreaByName 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 /HideColorOnAreaByName/{AreaName}/{Color} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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