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

<back to all web services

Hide

Requires Authentication
The following routes are available for this service:
All Verbs/Hide/{Key}/{Color}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class Hide
    {
        /**
        * Key identifying a location
        */
        @ApiMember(Description="Key identifying a location", IsRequired=true)
        public String Key = null;

        /**
        * HTML Color code (e.g. FF00FF)
        */
        @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
        public String Color = 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 to hide the position
        */
        @ApiMember(Description="Optional: name of the stockroom where to hide the position")
        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 getKey() { return Key; }
        public Hide setKey(String value) { this.Key = value; return this; }
        public String getColor() { return Color; }
        public Hide setColor(String value) { this.Color = value; return this; }
        public Integer getDelay() { return Delay; }
        public Hide setDelay(Integer value) { this.Delay = value; return this; }
        public String getStockroomName() { return StockroomName; }
        public Hide setStockroomName(String value) { this.StockroomName = value; return this; }
        public String getOwner() { return Owner; }
        public Hide setOwner(String value) { this.Owner = value; return this; }
    }

}

Java Hide DTOs

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

HTTP + XML

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

POST /Hide/{Key}/{Color} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Hide xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Delay>0</Delay>
  <Key>String</Key>
  <Owner>String</Owner>
  <StockroomName>String</StockroomName>
</Hide>