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

<back to all web services

PBL_SwitchOffPositions

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

public class dtos
{

    public static class PBL_SwitchOffPositions
    {
        /**
        * Positions identifying LED locations
        */
        @ApiMember(Description="Positions identifying LED locations", IsRequired=true)
        public ArrayList<String> Positions = new ArrayList<String>();

        /**
        * Optional: HTML Color code (e.g. FF00FF)
        */
        @ApiMember(Description="Optional: HTML Color code (e.g. FF00FF)")
        public String Color = 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: set paramter to TRUE if you need to turn off any color previously turned ON at specified positions
        */
        @ApiMember(Description="Optional: set paramter to TRUE if you need to turn off any color previously turned ON at specified positions")
        public Boolean SwitchOffAnyColor = null;
        
        public ArrayList<String> getPositions() { return Positions; }
        public PBL_SwitchOffPositions setPositions(ArrayList<String> value) { this.Positions = value; return this; }
        public String getColor() { return Color; }
        public PBL_SwitchOffPositions setColor(String value) { this.Color = value; return this; }
        public String getOwner() { return Owner; }
        public PBL_SwitchOffPositions setOwner(String value) { this.Owner = value; return this; }
        public Boolean isSwitchOffAnyColor() { return SwitchOffAnyColor; }
        public PBL_SwitchOffPositions setSwitchOffAnyColor(Boolean value) { this.SwitchOffAnyColor = value; return this; }
    }

    public static class PBL_StandardResponse
    {
        public Boolean Success = null;
        public String Error = null;
        public Object Result = null;
        public String Color = null;
        
        public Boolean isSuccess() { return Success; }
        public PBL_StandardResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public String getError() { return Error; }
        public PBL_StandardResponse setError(String value) { this.Error = value; return this; }
        public Object getResult() { return Result; }
        public PBL_StandardResponse setResult(Object value) { this.Result = value; return this; }
        public String getColor() { return Color; }
        public PBL_StandardResponse setColor(String value) { this.Color = value; return this; }
    }

}

Java PBL_SwitchOffPositions 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 /PBL_SwitchOffPositions HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Positions: 
	[
		String
	],
	Color: String,
	Owner: String,
	SwitchOffAnyColor: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Error: String,
	Result: {},
	Color: String
}