Trackunit API

<back to all web services

GetReportKeyHistory

The following routes are available for this service:
GET POST/report/keyhistory

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

    // @DataMember
    public time: string;

    // @DataMember
    public location: Location;

    // @DataMember
    public address: Address;

    // @DataMember
    public heading?: number;

    // @DataMember
    public speed?: number;

    // @DataMember
    public km?: number;

    // @DataMember
    public run1?: number;

    // @DataMember
    public run2?: number;

    // @DataMember
    public runOdo?: number;

    // @DataMember
    public temperature1?: number;

    // @DataMember
    public temperature2?: number;

    // @DataMember
    public input1?: boolean;

    // @DataMember
    public input2?: boolean;

    // @DataMember
    public output3?: boolean;

    // @DataMember
    public batteryLevel?: number;

    // @DataMember
    public externalPower?: number;

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

// @DataContract
export class GetReportKeyHistoryResponse
{
    // @DataMember
    public list: KeyHistory[];

    // @DataMember
    public responseStatus: ResponseStatus;

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

// @DataContract
export class GetReportKeyHistory
{
    // @DataMember
    public keyId: string;

    // @DataMember
    public from?: string;

    // @DataMember
    public to?: string;

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

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

{"keyId":"String","from":"0001-01-01T00:00:00.0000000Z","to":"0001-01-01T00:00:00.0000000Z"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"list":[{"unitId":"String","time":"0001-01-01T00:00:00.0000000Z","location":{"latitude":0,"longitude":0},"address":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"heading":0,"speed":0,"km":0,"run1":0,"run2":0,"runOdo":0,"temperature1":0,"temperature2":0,"input1":false,"input2":false,"output3":false,"batteryLevel":0,"externalPower":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}