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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<GetReportUnitSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Date>0001-01-01T00:00:00</Date>
  <UnitId>String</UnitId>
</GetReportUnitSummary>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetReportUnitSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <List>
    <UnitDaySummary>
      <Input1ChangeCounter>0</Input1ChangeCounter>
      <Input2ChangeCounter>0</Input2ChangeCounter>
      <Km>0</Km>
      <Run1>0</Run1>
      <Run2>0</Run2>
      <Run3>0</Run3>
      <Run4>0</Run4>
      <RunOdo>0</RunOdo>
      <StartAddress>
        <City>String</City>
        <Country>String</Country>
        <StreetAddress>String</StreetAddress>
        <ZipCode>String</ZipCode>
      </StartAddress>
      <StartLocation>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
      </StartLocation>
      <StartTime>0001-01-01T00:00:00</StartTime>
      <StopAddress>
        <City>String</City>
        <Country>String</Country>
        <StreetAddress>String</StreetAddress>
        <ZipCode>String</ZipCode>
      </StopAddress>
      <StopLocation>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
      </StopLocation>
      <StopTime>0001-01-01T00:00:00</StopTime>
      <UnitId>String</UnitId>
    </UnitDaySummary>
  </List>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</GetReportUnitSummaryResponse>