Trackunit API

<back to all web services

UpdateAlarm

The following routes are available for this service:
PUT/Alarm
PUT/Alarm/{Id}
GET POST/UpdateAlarm
GET POST/UpdateAlarm/{Id}
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 UpdateAlarmResponse:
    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 UpdateAlarm:
    id: Optional[str] = None
    name: Optional[str] = None
    enabled: Optional[bool] = None
    all_units: Optional[bool] = None
    clear_units: Optional[bool] = None
    add_units: Optional[List[str]] = None
    remove_units: Optional[List[str]] = None
    clear_groups: Optional[bool] = None
    add_groups: Optional[List[str]] = None
    remove_groups: Optional[List[str]] = None
    clear_email_recipients: Optional[bool] = None
    add_email_recipients: Optional[List[str]] = None
    remove_email_recipients: Optional[List[str]] = None
    clear_system_recipients: Optional[bool] = None
    add_system_recipients: Optional[List[str]] = None
    remove_system_recipients: Optional[List[str]] = None
    clear_sms_recipients: Optional[bool] = None
    add_sms_recipients: Optional[List[str]] = None
    remove_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

Python UpdateAlarm DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /UpdateAlarm HTTP/1.1 
Host: api.trackunit.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"id":"String","name":"String","enabled":false,"allUnits":false,"clearUnits":false,"addUnits":["String"],"removeUnits":["String"],"clearGroups":false,"addGroups":["String"],"removeGroups":["String"],"clearEmailRecipients":false,"addEmailRecipients":["String"],"removeEmailRecipients":["String"],"clearSystemRecipients":false,"addSystemRecipients":["String"],"removeSystemRecipients":["String"],"clearSmsRecipients":false,"addSmsRecipients":["String"],"removeSmsRecipients":["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: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}