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

<back to all web services

ShowOnAreaByName

Requires Authentication
The following routes are available for this service:
All Verbs/ShowOnAreaByName/{AreaName}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ShowOnAreaByName
    {
        /**
        * 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 area
        */
        @ApiMember(Description="Pixel number on the area", IsRequired=true)
        public Integer Pixel = null;

        /**
        * Pixel width
        */
        @ApiMember(Description="Pixel width", IsRequired=true)
        public Integer Width = null;

        /**
        * Blinking or not
        */
        @ApiMember(Description="Blinking or not", IsRequired=true)
        public Boolean Blink = null;

        /**
        * When set to false, it turns off the same color in a previous position
        */
        @ApiMember(Description="When set to false, it turns off the same color in a previous position", IsRequired=true)
        public Boolean Persistant = 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: duration of the show in seconds
        */
        @ApiMember(Description="Optional: duration of the show in seconds")
        public Integer Duration = 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;

        /**
        * Optional: indicates if message shall be delivered in an unreliable way (faster)
        */
        @ApiMember(Description="Optional: indicates if message shall be delivered in an unreliable way (faster)")
        public Boolean Unreliable = null;
        
        public String getAreaName() { return AreaName; }
        public ShowOnAreaByName setAreaName(String value) { this.AreaName = value; return this; }
        public String getColor() { return Color; }
        public ShowOnAreaByName setColor(String value) { this.Color = value; return this; }
        public Integer getPixel() { return Pixel; }
        public ShowOnAreaByName setPixel(Integer value) { this.Pixel = value; return this; }
        public Integer getWidth() { return Width; }
        public ShowOnAreaByName setWidth(Integer value) { this.Width = value; return this; }
        public Boolean isBlink() { return Blink; }
        public ShowOnAreaByName setBlink(Boolean value) { this.Blink = value; return this; }
        public Boolean isPersistant() { return Persistant; }
        public ShowOnAreaByName setPersistant(Boolean value) { this.Persistant = value; return this; }
        public Integer getDelay() { return Delay; }
        public ShowOnAreaByName setDelay(Integer value) { this.Delay = value; return this; }
        public Integer getDuration() { return Duration; }
        public ShowOnAreaByName setDuration(Integer value) { this.Duration = value; return this; }
        public String getStockroomName() { return StockroomName; }
        public ShowOnAreaByName setStockroomName(String value) { this.StockroomName = value; return this; }
        public String getOwner() { return Owner; }
        public ShowOnAreaByName setOwner(String value) { this.Owner = value; return this; }
        public Boolean isUnreliable() { return Unreliable; }
        public ShowOnAreaByName setUnreliable(Boolean value) { this.Unreliable = value; return this; }
    }

}

Java ShowOnAreaByName 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 /ShowOnAreaByName/{AreaName}/{Color}/{Pixel}/{Width}/{Blink}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ShowOnAreaByName xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <AreaName>String</AreaName>
  <Blink>false</Blink>
  <Color>String</Color>
  <Delay>0</Delay>
  <Duration>0</Duration>
  <Owner>String</Owner>
  <Persistant>false</Persistant>
  <Pixel>0</Pixel>
  <StockroomName>String</StockroomName>
  <Unreliable>false</Unreliable>
  <Width>0</Width>
</ShowOnAreaByName>