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}

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

    // @DataMember
    public startTime?: string;

    // @DataMember
    public startLocation: Location;

    // @DataMember
    public startAddress: Address;

    // @DataMember
    public stopTime?: string;

    // @DataMember
    public stopLocation: Location;

    // @DataMember
    public stopAddress: Address;

    // @DataMember
    public input1ChangeCounter: number;

    // @DataMember
    public input2ChangeCounter: number;

    // @DataMember
    public run1: number;

    // @DataMember
    public run2: number;

    // @DataMember
    public run3: number;

    // @DataMember
    public run4: number;

    // @DataMember
    public runOdo: number;

    // @DataMember
    public km: number;

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

// @DataContract
export class GetReportUnitSummaryResponse
{
    // @DataMember
    public list: UnitDaySummary[];

    // @DataMember
    public responseStatus: ResponseStatus;

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

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

    // @DataMember
    public date?: string;

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

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

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

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}