| GET | /alarmLog | ||
|---|---|---|---|
| GET POST | /GetAlarmLog |
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 Address:
country: Optional[str] = None
zip_code: Optional[str] = None
city: Optional[str] = None
street_address: Optional[str] = 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 AlarmRecipient:
contact_id: Optional[str] = None
sent_via: Optional[str] = None
phone_number: Optional[str] = None
email: Optional[str] = None
delivered: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AlarmLog:
alarm_id: Optional[str] = None
unit_id: Optional[str] = None
triggered_at: datetime.datetime = datetime.datetime(1, 1, 1)
address: Optional[Address] = None
location: Optional[Location] = None
recipients: Optional[List[AlarmRecipient]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAlarmLogResponse:
list: Optional[List[AlarmLog]] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAlarmLog:
unit_id: Optional[str] = None
date_from: Optional[datetime.datetime] = None
date_to: Optional[datetime.datetime] = None
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 /GetAlarmLog HTTP/1.1
Host: api.trackunit.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetAlarmLog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<DateFrom>0001-01-01T00:00:00</DateFrom>
<DateTo>0001-01-01T00:00:00</DateTo>
<UnitId>String</UnitId>
</GetAlarmLog>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetAlarmLogResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<List>
<AlarmLog>
<Address>
<City>String</City>
<Country>String</Country>
<StreetAddress>String</StreetAddress>
<ZipCode>String</ZipCode>
</Address>
<AlarmId>String</AlarmId>
<Location>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Location>
<Recipients>
<AlarmRecipient>
<ContactId>String</ContactId>
<Delivered>false</Delivered>
<Email>String</Email>
<PhoneNumber>String</PhoneNumber>
<SentVia>String</SentVia>
</AlarmRecipient>
</Recipients>
<TriggeredAt>0001-01-01T00:00:00</TriggeredAt>
<UnitId>String</UnitId>
</AlarmLog>
</List>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</GetAlarmLogResponse>