| 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<GetReportKeyHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<From>0001-01-01T00:00:00</From>
<KeyId>String</KeyId>
<To>0001-01-01T00:00:00</To>
</GetReportKeyHistory>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetReportKeyHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<List>
<KeyHistory>
<Address>
<City>String</City>
<Country>String</Country>
<StreetAddress>String</StreetAddress>
<ZipCode>String</ZipCode>
</Address>
<BatteryLevel>0</BatteryLevel>
<ExternalPower>0</ExternalPower>
<Heading>0</Heading>
<Input1>false</Input1>
<Input2>false</Input2>
<Km>0</Km>
<Location>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Location>
<Output3>false</Output3>
<Run1>0</Run1>
<Run2>0</Run2>
<RunOdo>0</RunOdo>
<Speed>0</Speed>
<Temperature1>0</Temperature1>
<Temperature2>0</Temperature2>
<Time>0001-01-01T00:00:00</Time>
<UnitId>String</UnitId>
</KeyHistory>
</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>
</GetReportKeyHistoryResponse>