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

<back to all web services

ShowQuantityMultiple

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


open class ShowQuantityMultiple : ShowCommon()
{
    /**
    * Keys array identifying the locations
    */
    @ApiMember(Description="Keys array identifying the locations", IsRequired=true)
    open var Keys:ArrayList<String> = ArrayList<String>()

    /**
    * Quantity: number of LED to show
    */
    @ApiMember(Description="Quantity: number of LED to show", IsRequired=true)
    open var Quantity:Int? = null

    /**
    * Optional: Force blinking
    */
    @ApiMember(Description="Optional: Force blinking")
    open var ForceBlink:Boolean? = null

    /**
    * Animated effect selection: 0 = Always ON (no effect), 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="Animated effect selection: 0 = Always ON (no effect), 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
}

open class ShowCommon
{
    /**
    * HTML Color code (e.g. FF00FF)
    */
    @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
    open var Color:String? = 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)
    open var Persistant:Boolean? = null

    /**
    * Optional: delay the execution of the command (in seconds)
    */
    @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
    open var Delay:Int? = null

    /**
    * Optional: duration of the show in seconds
    */
    @ApiMember(Description="Optional: duration of the show in seconds")
    open var Duration:Int? = null

    /**
    * Optional: name of the stockroom where to show the position
    */
    @ApiMember(Description="Optional: name of the stockroom where to show the position")
    open var StockroomName:String? = 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: 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)")
    open var Unreliable:Boolean? = null

    /**
    * Optional: indicates if the header shall be displayed
    */
    @ApiMember(Description="Optional: indicates if the header shall be displayed")
    open var DisplayHeader:Boolean? = null
}

Kotlin ShowQuantityMultiple 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 /ShowQuantityMultiple/{Keys}/{Color}/{Quantity}/{Persistant} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ShowQuantityMultiple xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Delay>0</Delay>
  <DisplayHeader>false</DisplayHeader>
  <Duration>0</Duration>
  <Owner>String</Owner>
  <Persistant>false</Persistant>
  <StockroomName>String</StockroomName>
  <Unreliable>false</Unreliable>
  <Effect>0</Effect>
  <ForceBlink>false</ForceBlink>
  <Keys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Keys>
  <Quantity>0</Quantity>
</ShowQuantityMultiple>