Trackunit API

<back to all web services

GetAlarmLog

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

// @DataContract
export class Address
{
    // @DataMember
    public country: string;

    // @DataMember
    public zipCode: string;

    // @DataMember
    public city: string;

    // @DataMember
    public streetAddress: string;

    public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Location
{
    // @DataMember
    public latitude: number;

    // @DataMember
    public longitude: number;

    public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AlarmRecipient
{
    // @DataMember
    public contactId: string;

    // @DataMember
    public sentVia: string;

    // @DataMember
    public phoneNumber: string;

    // @DataMember
    public email: string;

    // @DataMember
    public delivered: boolean;

    public constructor(init?: Partial<AlarmRecipient>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AlarmLog
{
    // @DataMember
    public alarmId: string;

    // @DataMember
    public unitId: string;

    // @DataMember
    public triggeredAt: string;

    // @DataMember
    public address: Address;

    // @DataMember
    public location: Location;

    // @DataMember
    public recipients: AlarmRecipient[];

    public constructor(init?: Partial<AlarmLog>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetAlarmLogResponse
{
    // @DataMember
    public list: AlarmLog[];

    // @DataMember
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetAlarmLogResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetAlarmLog
{
    // @DataMember
    public unitId: string;

    // @DataMember
    public dateFrom?: string;

    // @DataMember
    public dateTo?: string;

    public constructor(init?: Partial<GetAlarmLog>) { (Object as any).assign(this, init); }
}

TypeScript GetAlarmLog DTOs

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 /GetAlarmLog HTTP/1.1 
Host: api.trackunit.com 
Accept: application/json
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"}}}