Trackunit API

<back to all web services

GetReportUnitHistory

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

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

    // @DataMember
    public event: number;

    // @DataMember
    public keyId: 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 run3?: number;

    // @DataMember
    public run4?: number;

    // @DataMember
    public runOdo?: number;

    // @DataMember
    public temperature1?: number;

    // @DataMember
    public temperature2?: number;

    // @DataMember
    public input1?: boolean;

    // @DataMember
    public input2?: boolean;

    // @DataMember
    public input3?: boolean;

    // @DataMember
    public input4?: boolean;

    // @DataMember
    public input5?: boolean;

    // @DataMember
    public input6?: boolean;

    // @DataMember
    public input7?: boolean;

    // @DataMember
    public input8?: boolean;

    // @DataMember
    public input9?: boolean;

    // @DataMember
    public input10?: boolean;

    // @DataMember
    public output1?: boolean;

    // @DataMember
    public output2?: boolean;

    // @DataMember
    public output3?: boolean;

    // @DataMember
    public output4?: boolean;

    // @DataMember
    public output5?: boolean;

    // @DataMember
    public analogInput1?: number;

    // @DataMember
    public analogInput2?: number;

    // @DataMember
    public analogInput4?: number;

    // @DataMember
    public input1ChangeCounter?: number;

    // @DataMember
    public input2ChangeCounter?: number;

    // @DataMember
    public input3ChangeCounter?: number;

    // @DataMember
    public input4ChangeCounter?: number;

    // @DataMember
    public batteryLevel?: number;

    // @DataMember
    public externalPower?: number;

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

// @DataContract
export class GetReportUnitHistoryResponse
{
    // @DataMember
    public list: UnitHistory[];

    // @DataMember
    public responseStatus: ResponseStatus;

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

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

    // @DataMember
    public from?: string;

    // @DataMember
    public to?: string;

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

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

{"unitId":"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":[{"time":"0001-01-01T00:00:00.0000000Z","event":0,"keyId":"String","location":{"latitude":0,"longitude":0},"address":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"heading":0,"speed":0,"km":0,"run1":0,"run2":0,"run3":0,"run4":0,"runOdo":0,"temperature1":0,"temperature2":0,"input1":false,"input2":false,"input3":false,"input4":false,"input5":false,"input6":false,"input7":false,"input8":false,"input9":false,"input10":false,"output1":false,"output2":false,"output3":false,"output4":false,"output5":false,"analogInput1":0,"analogInput2":0,"analogInput4":0,"input1ChangeCounter":0,"input2ChangeCounter":0,"input3ChangeCounter":0,"input4ChangeCounter":0,"batteryLevel":0,"externalPower":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}