| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Positions:
[
String
],
Quantities:
[
0
],
Effect: 0,
Color: String,
HidePreviousPosition: False,
Owner: String,
StockroomName: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Success: False,
Error: String,
Result: {},
Color: String
}