Trackunit API

<back to all web services

GetReportUnitSummary

The following routes are available for this service:
GET POST/report/unitsummary
GET POST/report/unitsummary/{Id}
"use strict";
export class Location {
    /** @param {{latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
}
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 UnitDaySummary {
    /** @param {{unitId?:string,startTime?:string,startLocation?:Location,startAddress?:Address,stopTime?:string,stopLocation?:Location,stopAddress?:Address,input1ChangeCounter?:number,input2ChangeCounter?:number,run1?:number,run2?:number,run3?:number,run4?:number,runOdo?:number,km?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    unitId;
    /** @type {?string} */
    startTime;
    /** @type {Location} */
    startLocation;
    /** @type {Address} */
    startAddress;
    /** @type {?string} */
    stopTime;
    /** @type {Location} */
    stopLocation;
    /** @type {Address} */
    stopAddress;
    /** @type {number} */
    input1ChangeCounter;
    /** @type {number} */
    input2ChangeCounter;
    /** @type {number} */
    run1;
    /** @type {number} */
    run2;
    /** @type {number} */
    run3;
    /** @type {number} */
    run4;
    /** @type {number} */
    runOdo;
    /** @type {number} */
    km;
}
export class GetReportUnitSummaryResponse {
    /** @param {{list?:UnitDaySummary[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {UnitDaySummary[]} */
    list;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetReportUnitSummary {
    /** @param {{unitId?:string,date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    unitId;
    /** @type {?string} */
    date;
}

JavaScript GetReportUnitSummary 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 /report/unitsummary HTTP/1.1 
Host: api.trackunit.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"unitId":"String","date":"0001-01-01T00:00:00.0000000Z"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"list":[{"unitId":"String","startTime":"0001-01-01T00:00:00.0000000Z","startLocation":{"latitude":0,"longitude":0},"startAddress":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"stopTime":"0001-01-01T00:00:00.0000000Z","stopLocation":{"latitude":0,"longitude":0},"stopAddress":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"input1ChangeCounter":0,"input2ChangeCounter":0,"run1":0,"run2":0,"run3":0,"run4":0,"runOdo":0,"km":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}