Trackunit API

<back to all web services

GetAlarmLog

The following routes are available for this service:
GET/alarmLog
GET POST/GetAlarmLog
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract
open class GetAlarmLog
{
    @DataMember
    open var unitId:String? = null

    @DataMember
    open var dateFrom:Date? = null

    @DataMember
    open var dateTo:Date? = null
}

@DataContract
open class GetAlarmLogResponse
{
    @DataMember
    open var list:ArrayList<AlarmLog>? = null

    @DataMember
    open var responseStatus:ResponseStatus? = null
}

@DataContract
open class AlarmLog
{
    @DataMember
    open var alarmId:String? = null

    @DataMember
    open var unitId:String? = null

    @DataMember
    open var triggeredAt:Date? = null

    @DataMember
    open var address:Address? = null

    @DataMember
    open var location:Location? = null

    @DataMember
    open var recipients:ArrayList<AlarmRecipient>? = null
}

@DataContract
open class Address
{
    @DataMember
    open var country:String? = null

    @DataMember
    open var zipCode:String? = null

    @DataMember
    open var city:String? = null

    @DataMember
    open var streetAddress:String? = null
}

@DataContract
open class Location
{
    @DataMember
    open var latitude:Double? = null

    @DataMember
    open var longitude:Double? = null
}

@DataContract
open class AlarmRecipient
{
    @DataMember
    open var contactId:String? = null

    @DataMember
    open var sentVia:String? = null

    @DataMember
    open var phoneNumber:String? = null

    @DataMember
    open var email:String? = null

    @DataMember
    open var delivered:Boolean? = null
}

Kotlin 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"}}}