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}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Location:
    latitude: float = 0.0
    longitude: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Address:
    country: Optional[str] = None
    zip_code: Optional[str] = None
    city: Optional[str] = None
    street_address: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UnitDaySummary:
    unit_id: Optional[str] = None
    start_time: Optional[datetime.datetime] = None
    start_location: Optional[Location] = None
    start_address: Optional[Address] = None
    stop_time: Optional[datetime.datetime] = None
    stop_location: Optional[Location] = None
    stop_address: Optional[Address] = None
    input1_change_counter: int = 0
    input2_change_counter: int = 0
    run1: float = 0.0
    run2: float = 0.0
    run3: float = 0.0
    run4: float = 0.0
    run_odo: float = 0.0
    km: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetReportUnitSummaryResponse:
    list: Optional[List[UnitDaySummary]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetReportUnitSummary:
    unit_id: Optional[str] = None
    date: Optional[datetime.datetime] = None

Python 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>