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}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class HideColorOnAreaByName
{
    /**
    * Area Name
    */
    @ApiMember(Description="Area Name", IsRequired=true)
    open var AreaName:String? = null

    /**
    * HTML Color code (e.g. FF00FF)
    */
    @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
    open var Color:String? = null

    /**
    * Optional: delay the execution of the command (in seconds)
    */
    @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
    open var Delay:Int? = null

    /**
    * Optional: name of the stockroom where the area is located
    */
    @ApiMember(Description="Optional: name of the stockroom where the area is located")
    open var StockroomName:String? = null

    /**
    * Optional: name of the owner of the color/command to allow color sharing
    */
    @ApiMember(Description="Optional: name of the owner of the color/command to allow color sharing")
    open var Owner:String? = null
}

Kotlin 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
}