Go-to-Light Service 3.1.1.1547 - 97 - API License to GTL Cloud

<back to all web services

ShowQuantityMultiple

Requires Authentication
The following routes are available for this service:
All Verbs/ShowQuantityMultiple/{Keys}/{Color}/{Quantity}/{Persistant}
ShowQuantityMultiple Parameters:
NameParameterData TypeRequiredDescription
Keyspathstring[]YesKeys array identifying the locations
QuantitypathintYesQuantity: number of LED to show
ForceBlinkquerybool?NoOptional: Force blinking
Effectqueryint?NoAnimated 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
ShowCommon Parameters:
NameParameterData TypeRequiredDescription
ColorformstringYesHTML Color code (e.g. FF00FF)
PersistantformboolYesWhen set to false, it turns off the same color in a previous position
Delayformint?NoOptional: delay the execution of the command (in seconds)
Durationformint?NoOptional: duration of the show in seconds
StockroomNameformstringNoOptional: name of the stockroom where to show the position
OwnerformstringNoOptional: name of the owner of the color/command to allow color sharing
Unreliableformbool?NoOptional: indicates if message shall be delivered in an unreliable way (faster)
DisplayHeaderformbool?NoOptional: indicates if the header shall be displayed

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>