Trackunit API

<back to all web services

GetAlarmLog

The following routes are available for this service:
GET/alarmLog
GET POST/GetAlarmLog
"use strict";
export class Address {
    /** @param {{country?:string,zipCode?:string,city?:string,streetAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    country;
    /** @type {string} */
    zipCode;
    /** @type {string} */
    city;
    /** @type {string} */
    streetAddress;
}
export class Location {
    /** @param {{latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
}
export class AlarmRecipient {
    /** @param {{contactId?:string,sentVia?:string,phoneNumber?:string,email?:string,delivered?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    contactId;
    /** @type {string} */
    sentVia;
    /** @type {string} */
    phoneNumber;
    /** @type {string} */
    email;
    /** @type {boolean} */
    delivered;
}
export class AlarmLog {
    /** @param {{alarmId?:string,unitId?:string,triggeredAt?:string,address?:Address,location?:Location,recipients?:AlarmRecipient[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    alarmId;
    /** @type {string} */
    unitId;
    /** @type {string} */
    triggeredAt;
    /** @type {Address} */
    address;
    /** @type {Location} */
    location;
    /** @type {AlarmRecipient[]} */
    recipients;
}
export class GetAlarmLogResponse {
    /** @param {{list?:AlarmLog[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AlarmLog[]} */
    list;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetAlarmLog {
    /** @param {{unitId?:string,dateFrom?:string,dateTo?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    unitId;
    /** @type {?string} */
    dateFrom;
    /** @type {?string} */
    dateTo;
}

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