Trackunit API

<back to all web services

GetReportKeyHistory

The following routes are available for this service:
GET POST/report/keyhistory
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 KeyHistory:
    unit_id: Optional[str] = None
    time: datetime.datetime = datetime.datetime(1, 1, 1)
    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
    run_odo: Optional[float] = None
    temperature1: Optional[float] = None
    temperature2: Optional[float] = None
    input1: Optional[bool] = None
    input2: Optional[bool] = None
    output3: Optional[bool] = None
    battery_level: Optional[float] = None
    external_power: Optional[float] = None


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


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

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

{"keyId":"String","from":"0001-01-01T00:00:00.0000000Z","to":"0001-01-01T00:00:00.0000000Z"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"list":[{"unitId":"String","time":"0001-01-01T00:00:00.0000000Z","location":{"latitude":0,"longitude":0},"address":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"heading":0,"speed":0,"km":0,"run1":0,"run2":0,"runOdo":0,"temperature1":0,"temperature2":0,"input1":false,"input2":false,"output3":false,"batteryLevel":0,"externalPower":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}