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

<back to all web services

PBL_ShowQuantity

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

public class dtos
{

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

        /**
        * Quantity: Number of LED to show
        */
        @ApiMember(Description="Quantity: Number of LED to show", IsRequired=true)
        public Integer Quantity = null;

        /**
        * Optional: Animated effect selection: 0 = Always ON (no effect, default), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW
        */
        @ApiMember(Description="Optional: Animated effect selection: 0 = Always ON (no effect, default), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW")
        public Integer Effect = null;

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

        /**
        * Optional: When set to true, it turns off the same color in a previous position
        */
        @ApiMember(Description="Optional: When set to true, it turns off the same color in a previous position")
        public Boolean HidePreviousPosition = 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 getPosition() { return Position; }
        public PBL_ShowQuantity setPosition(String value) { this.Position = value; return this; }
        public Integer getQuantity() { return Quantity; }
        public PBL_ShowQuantity setQuantity(Integer value) { this.Quantity = value; return this; }
        public Integer getEffect() { return Effect; }
        public PBL_ShowQuantity setEffect(Integer value) { this.Effect = value; return this; }
        public String getColor() { return Color; }
        public PBL_ShowQuantity setColor(String value) { this.Color = value; return this; }
        public Boolean isHidePreviousPosition() { return HidePreviousPosition; }
        public PBL_ShowQuantity setHidePreviousPosition(Boolean value) { this.HidePreviousPosition = value; return this; }
        public String getOwner() { return Owner; }
        public PBL_ShowQuantity setOwner(String value) { this.Owner = 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_ShowQuantity 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 /PBL_ShowQuantity HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Position":"String","Quantity":0,"Effect":0,"Color":"String","HidePreviousPosition":false,"Owner":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Success":false,"Error":"String","Result":{},"Color":"String"}