Trackunit API

<back to all web services

GetAlarmLog

The following routes are available for this service:
GET/alarmLog
GET POST/GetAlarmLog
import Foundation
import ServiceStack

// @DataContract
public class GetAlarmLog : Codable
{
    // @DataMember
    public var unitId:String

    // @DataMember
    public var dateFrom:Date?

    // @DataMember
    public var dateTo:Date?

    required public init(){}
}

// @DataContract
public class GetAlarmLogResponse : Codable
{
    // @DataMember
    public var list:[AlarmLog]

    // @DataMember
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class AlarmLog : Codable
{
    // @DataMember
    public var alarmId:String

    // @DataMember
    public var unitId:String

    // @DataMember
    public var triggeredAt:Date

    // @DataMember
    public var address:Address

    // @DataMember
    public var location:Location

    // @DataMember
    public var recipients:[AlarmRecipient]

    required public init(){}
}

// @DataContract
public class Address : Codable
{
    // @DataMember
    public var country:String

    // @DataMember
    public var zipCode:String

    // @DataMember
    public var city:String

    // @DataMember
    public var streetAddress:String

    required public init(){}
}

// @DataContract
public class Location : Codable
{
    // @DataMember
    public var latitude:Double

    // @DataMember
    public var longitude:Double

    required public init(){}
}

// @DataContract
public class AlarmRecipient : Codable
{
    // @DataMember
    public var contactId:String

    // @DataMember
    public var sentVia:String

    // @DataMember
    public var phoneNumber:String

    // @DataMember
    public var email:String

    // @DataMember
    public var delivered:Bool

    required public init(){}
}


Swift GetAlarmLog 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 /GetAlarmLog HTTP/1.1 
Host: api.trackunit.com 
Accept: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
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"}}}