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

<back to all web services

PBL_ShowQuantities

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


open class PBL_ShowQuantities
{
    /**
    * Positions identifying the LED locations
    */
    @ApiMember(Description="Positions identifying the LED locations", IsRequired=true)
    open var Positions:ArrayList<String> = ArrayList<String>()

    /**
    * Quantities: Number of LED to show corresponding to each position
    */
    @ApiMember(Description="Quantities: Number of LED to show corresponding to each position", IsRequired=true)
    open var Quantities:ArrayList<Int> = ArrayList<Int>()

    /**
    * 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")
    open var Effect:Int? = null

    /**
    * Optional: HTML Color code (e.g. FF00FF)
    */
    @ApiMember(Description="Optional: HTML Color code (e.g. FF00FF)")
    open var Color:String? = 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")
    open var HidePreviousPosition:Boolean? = 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")
    open var Owner:String? = null

    /**
    * Optional: name of the stockroom where the positions are located
    */
    @ApiMember(Description="Optional: name of the stockroom where the positions are located")
    open var StockroomName:String? = null
}

open class PBL_StandardResponse
{
    open var Success:Boolean? = null
    open var Error:String? = null
    open var Result:Object? = null
    open var Color:String? = null
}

Kotlin PBL_ShowQuantities 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 /PBL_ShowQuantities HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PBL_ShowQuantities xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Effect>0</Effect>
  <HidePreviousPosition>false</HidePreviousPosition>
  <Owner>String</Owner>
  <Positions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Positions>
  <Quantities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Quantities>
  <StockroomName>String</StockroomName>
</PBL_ShowQuantities>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PBL_StandardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Error>String</Error>
  <Result />
  <Success>false</Success>
</PBL_StandardResponse>