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

public class dtos
{

    public static class HideOnAreaByName
    {
        /**
        * Area Name
        */
        @ApiMember(Description="Area Name", IsRequired=true)
        public String AreaName = null;

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

        /**
        * Pixel number on the group
        */
        @ApiMember(Description="Pixel number on the group", IsRequired=true)
        public Integer Pixel = null;

        /**
        * Optional: delay the execution of the command (in seconds)
        */
        @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
        public Integer Delay = null;

        /**
        * Optional: name of the stockroom where the area is located
        */
        @ApiMember(Description="Optional: name of the stockroom where the area is located")
        public String StockroomName = 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")
        public String Owner = null;
        
        public String getAreaName() { return AreaName; }
        public HideOnAreaByName setAreaName(String value) { this.AreaName = value; return this; }
        public String getColor() { return Color; }
        public HideOnAreaByName setColor(String value) { this.Color = value; return this; }
        public Integer getPixel() { return Pixel; }
        public HideOnAreaByName setPixel(Integer value) { this.Pixel = value; return this; }
        public Integer getDelay() { return Delay; }
        public HideOnAreaByName setDelay(Integer value) { this.Delay = value; return this; }
        public String getStockroomName() { return StockroomName; }
        public HideOnAreaByName setStockroomName(String value) { this.StockroomName = value; return this; }
        public String getOwner() { return Owner; }
        public HideOnAreaByName setOwner(String value) { this.Owner = value; return this; }
    }

}

Java HideOnAreaByName DTOs

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

HTTP + CSV

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

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