Trackunit API

<back to all web services

GetReportUnitHistory

The following routes are available for this service:
GET POST/report/unithistory
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 UnitHistory:
    time: datetime.datetime = datetime.datetime(1, 1, 1)
    event: int = 0
    key_id: Optional[str] = None
    location: Optional[Location] = None
    address: Optional[Address] = None
    heading: Optional[int] = None
    speed: Optional[float] = None
    km: Optional[float] = None
    run1: Optional[float] = None
    run2: Optional[float] = None
    run3: Optional[float] = None
    run4: Optional[float] = None
    run_odo: Optional[float] = None
    temperature1: Optional[float] = None
    temperature2: Optional[float] = None
    input1: Optional[bool] = None
    input2: Optional[bool] = None
    input3: Optional[bool] = None
    input4: Optional[bool] = None
    input5: Optional[bool] = None
    input6: Optional[bool] = None
    input7: Optional[bool] = None
    input8: Optional[bool] = None
    input9: Optional[bool] = None
    input10: Optional[bool] = None
    output1: Optional[bool] = None
    output2: Optional[bool] = None
    output3: Optional[bool] = None
    output4: Optional[bool] = None
    output5: Optional[bool] = None
    analog_input1: Optional[float] = None
    analog_input2: Optional[float] = None
    analog_input4: Optional[float] = None
    input1_change_counter: Optional[int] = None
    input2_change_counter: Optional[int] = None
    input3_change_counter: Optional[int] = None
    input4_change_counter: Optional[int] = None
    battery_level: Optional[float] = None
    external_power: Optional[float] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetReportUnitHistory:
    unit_id: Optional[str] = None
    from_: Optional[datetime.datetime] = field(metadata=config(field_name='from'), default=None)
    to: Optional[datetime.datetime] = None

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

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

<GetReportUnitHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <List>
    <UnitHistory>
      <Address>
        <City>String</City>
        <Country>String</Country>
        <StreetAddress>String</StreetAddress>
        <ZipCode>String</ZipCode>
      </Address>
      <AnalogInput1>0</AnalogInput1>
      <AnalogInput2>0</AnalogInput2>
      <AnalogInput4>0</AnalogInput4>
      <BatteryLevel>0</BatteryLevel>
      <Event>0</Event>
      <ExternalPower>0</ExternalPower>
      <Heading>0</Heading>
      <Input1>false</Input1>
      <Input10>false</Input10>
      <Input1ChangeCounter>0</Input1ChangeCounter>
      <Input2>false</Input2>
      <Input2ChangeCounter>0</Input2ChangeCounter>
      <Input3>false</Input3>
      <Input3ChangeCounter>0</Input3ChangeCounter>
      <Input4>false</Input4>
      <Input4ChangeCounter>0</Input4ChangeCounter>
      <Input5>false</Input5>
      <Input6>false</Input6>
      <Input7>false</Input7>
      <Input8>false</Input8>
      <Input9>false</Input9>
      <KeyId>String</KeyId>
      <Km>0</Km>
      <Location>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
      </Location>
      <Output1>false</Output1>
      <Output2>false</Output2>
      <Output3>false</Output3>
      <Output4>false</Output4>
      <Output5>false</Output5>
      <Run1>0</Run1>
      <Run2>0</Run2>
      <Run3>0</Run3>
      <Run4>0</Run4>
      <RunOdo>0</RunOdo>
      <Speed>0</Speed>
      <Temperature1>0</Temperature1>
      <Temperature2>0</Temperature2>
      <Time>0001-01-01T00:00:00</Time>
    </UnitHistory>
  </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>
</GetReportUnitHistoryResponse>