| All Verbs | /PBL_ShowQuantities |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PBL_ShowQuantities:
# @ApiMember(Description="Positions identifying the LED locations", IsRequired=true)
positions: List[str] = field(default_factory=list)
"""
Positions identifying the LED locations
"""
# @ApiMember(Description="Quantities: Number of LED to show corresponding to each position", IsRequired=true)
quantities: List[int] = field(default_factory=list)
"""
Quantities: Number of LED to show corresponding to each position
"""
# @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")
effect: Optional[int] = None
"""
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: HTML Color code (e.g. FF00FF)")
color: Optional[str] = None
"""
Optional: HTML Color code (e.g. FF00FF)
"""
# @ApiMember(Description="Optional: When set to true, it turns off the same color in a previous position")
hide_previous_position: Optional[bool] = None
"""
Optional: When set to true, it turns off the same color in a previous position
"""
# @ApiMember(Description="Optional: Name of the owner of the color/command to allow color sharing")
owner: Optional[str] = None
"""
Optional: Name of the owner of the color/command to allow color sharing
"""
# @ApiMember(Description="Optional: name of the stockroom where the positions are located")
stockroom_name: Optional[str] = None
"""
Optional: name of the stockroom where the positions are located
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PBL_StandardResponse:
success: bool = False
error: Optional[str] = None
result: Optional[Object] = None
color: Optional[str] = None
Python PBL_ShowQuantities DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>