Trackunit API

<back to all web services

GetActiveAlarm

The following routes are available for this service:
GET/activeAlarm
GET POST/GetActiveAlarm

// @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 ActiveAlarm
{
    // @DataMember
    public alarmId: string;

    // @DataMember
    public unitId: string;

    // @DataMember
    public triggeredAt?: string;

    // @DataMember
    public address: Address;

    // @DataMember
    public location: Location;

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

// @DataContract
export class GetActiveAlarmResponse
{
    // @DataMember
    public list: ActiveAlarm[];

    // @DataMember
    public responseStatus: ResponseStatus;

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

// @DataContract
export class GetActiveAlarm
{

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

TypeScript GetActiveAlarm 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 /GetActiveAlarm HTTP/1.1 
Host: api.trackunit.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{}
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}}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}