Trackunit API

<back to all web services

GetAlarmLog

The following routes are available for this service:
GET/alarmLog
GET POST/GetAlarmLog
GetAlarmLog Parameters:
NameParameterData TypeRequiredDescription
UnitIdbodystringNo
DateFrombodyDateTime?No
DateTobodyDateTime?No
GetAlarmLogResponse Parameters:
NameParameterData TypeRequiredDescription
ListformList<AlarmLog>No
ResponseStatusformResponseStatusNo
AlarmLog Parameters:
NameParameterData TypeRequiredDescription
AlarmIdformstringNo
UnitIdformstringNo
TriggeredAtformDateTimeNo
AddressformAddressNo
LocationformLocationNo
RecipientsformList<AlarmRecipient>No
Address Parameters:
NameParameterData TypeRequiredDescription
CountryformstringNo
ZipCodeformstringNo
CityformstringNo
StreetAddressformstringNo
Location Parameters:
NameParameterData TypeRequiredDescription
LatitudeformdoubleNo
LongitudeformdoubleNo
AlarmRecipient Parameters:
NameParameterData TypeRequiredDescription
ContactIdformstringNo
SentViaformstringNo
PhoneNumberformstringNo
EmailformstringNo
DeliveredformboolNo

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

HTTP + JSON

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

POST /json/reply/GetAlarmLog HTTP/1.1 
Host: api.trackunit.com 
Content-Type: application/json
Content-Length: length

{"unitId":"String","dateFrom":"0001-01-01T00:00:00.0000000Z","dateTo":"0001-01-01T00:00:00.0000000Z"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"list":[{"alarmId":"String","unitId":"String","triggeredAt":"0001-01-01T00:00:00.0000000Z","address":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"location":{"latitude":0,"longitude":0},"recipients":[{"contactId":"String","sentVia":"String","phoneNumber":"String","email":"String","delivered":false}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}