| All Verbs | /HideOnAreaByName/{AreaName}/{Color}/{Pixel} |
|---|
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 HideOnAreaByName:
# @ApiMember(Description="Area Name", IsRequired=true)
area_name: Optional[str] = None
"""
Area Name
"""
# @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
color: Optional[str] = None
"""
HTML Color code (e.g. FF00FF)
"""
# @ApiMember(Description="Pixel number on the group", IsRequired=true)
pixel: int = 0
"""
Pixel number on the group
"""
# @ApiMember(Description="Optional: delay the execution of the command (in seconds)")
delay: Optional[int] = None
"""
Optional: delay the execution of the command (in seconds)
"""
# @ApiMember(Description="Optional: name of the stockroom where the area is located")
stockroom_name: Optional[str] = None
"""
Optional: name of the stockroom where the area is located
"""
# @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
"""
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 /HideOnAreaByName/{AreaName}/{Color}/{Pixel} HTTP/1.1
Host: clouddemo.pickeos.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AreaName: String,
Color: String,
Pixel: 0,
Delay: 0,
StockroomName: String,
Owner: String
}