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

<back to all web services

HideOnAreaByName

Requires Authentication
The following routes are available for this service:
All Verbs/HideOnAreaByName/{AreaName}/{Color}/{Pixel}
import Foundation
import ServiceStack

public class HideOnAreaByName : Codable
{
    /**
    * Area Name
    */
    // @ApiMember(Description="Area Name", IsRequired=true)
    public var areaName:String

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

    /**
    * Pixel number on the group
    */
    // @ApiMember(Description="Pixel number on the group", IsRequired=true)
    public var pixel:Int

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

    /**
    * Optional: name of the stockroom where the area is located
    */
    // @ApiMember(Description="Optional: name of the stockroom where the area is located")
    public var stockroomName:String

    /**
    * 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")
    public var owner:String

    required public init(){}
}


Swift HideOnAreaByName DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /HideOnAreaByName/{AreaName}/{Color}/{Pixel} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

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