| POST | /Alarm | ||
|---|---|---|---|
| GET POST | /CreateAlarm |
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 CreateAlarmResponse:
id: Optional[str] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TemperatureAlarmLimits:
temperature1_lower_limit: Optional[float] = None
temperature1_upper_limit: Optional[float] = None
temperature2_lower_limit: Optional[float] = None
temperature2_upper_limit: Optional[float] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ADVoltageAlarmLimits:
ad_voltage_lower_limit: Optional[float] = None
ad_voltage_upper_limit: Optional[float] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Location:
latitude: float = 0.0
longitude: float = 0.0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TimeOfDay:
hour: int = 0
minute: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateAlarm:
name: Optional[str] = None
type: Optional[str] = None
enabled: Optional[bool] = None
all_units: Optional[bool] = None
units: Optional[List[str]] = None
groups: Optional[List[str]] = None
email_recipients: Optional[List[str]] = None
system_recipients: Optional[List[str]] = None
sms_recipients: Optional[List[str]] = None
temperature_limits: Optional[TemperatureAlarmLimits] = None
ad_voltage_limits: Optional[ADVoltageAlarmLimits] = None
ad_voltage_input_index: Optional[int] = None
threshold: Optional[float] = None
battery_level: Optional[float] = None
location: Optional[Location] = None
radius: Optional[float] = None
input_index: Optional[int] = None
interval: Optional[float] = None
point_id: Optional[str] = None
expected_arrival_time: Optional[datetime.datetime] = None
power_level: Optional[float] = None
weekdays: Optional[List[str]] = None
time_start: Optional[TimeOfDay] = None
time_end: Optional[TimeOfDay] = None
zone_id: Optional[str] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Alarm HTTP/1.1
Host: api.trackunit.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"name":"String","type":"String","enabled":false,"allUnits":false,"units":["String"],"groups":["String"],"emailRecipients":["String"],"systemRecipients":["String"],"smsRecipients":["String"],"temperatureLimits":{"temperature1LowerLimit":0,"temperature1UpperLimit":0,"temperature2LowerLimit":0,"temperature2UpperLimit":0},"adVoltageLimits":{"adVoltageLowerLimit":0,"adVoltageUpperLimit":0},"adVoltageInputIndex":0,"threshold":0,"batteryLevel":0,"location":{"latitude":0,"longitude":0},"radius":0,"inputIndex":0,"interval":0,"pointId":"String","expectedArrivalTime":"0001-01-01T00:00:00.0000000Z","powerLevel":0,"weekdays":["String"],"timeStart":{"hour":0,"minute":0},"timeEnd":{"hour":0,"minute":0},"zoneId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"id":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}