Trackunit API

<back to all web services

GetUnit

The following routes are available for this service:
GET/unit
GET/unit/{Id}
GET POST/GetUnit
GET POST/GetUnit/{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 Unit:
    id: Optional[str] = None
    serial_number: Optional[str] = None
    phone_number: Optional[str] = None
    vehicle_type: Optional[str] = None
    device_type: Optional[str] = None
    device_model: Optional[str] = None
    name: Optional[str] = None
    display_name: Optional[str] = None
    reference_number: Optional[str] = None
    note: Optional[str] = None
    created_at: datetime.datetime = datetime.datetime(1, 1, 1)
    input1_name: Optional[str] = None
    input2_name: Optional[str] = None
    input3_name: Optional[str] = None
    input4_name: Optional[str] = None
    category_id: Optional[str] = None
    client_id: Optional[str] = None
    gps_fix_time: Optional[datetime.datetime] = None
    message_time: Optional[datetime.datetime] = None
    location: Optional[Location] = None
    altitude: Optional[float] = None
    heading: Optional[int] = None
    speed: Optional[float] = None
    address: Optional[Address] = None
    temperature1: Optional[float] = None
    temperature2: Optional[float] = None
    gsm_level: Optional[float] = None
    gsm_signal_quality: Optional[str] = None
    gps_signal_quality: Optional[str] = None
    battery_level: Optional[float] = None
    external_power: Optional[float] = None
    pre_run1: float = 0.0
    pre_run2: float = 0.0
    run1: Optional[float] = None
    run2: Optional[float] = None
    run3: Optional[float] = None
    run4: Optional[float] = None
    run_odo: Optional[float] = None
    pre_km: float = 0.0
    km: 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
    is_active: bool = False
    key_id: Optional[str] = None
    is_own: bool = False
    current_stop: Optional[float] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetUnit:
    id: Optional[str] = None
    serial_number: Optional[str] = None
    reference_number: Optional[str] = None
    category_id: Optional[str] = None
    client_id: Optional[str] = None
    group_id: Optional[str] = None
    zone_id: Optional[str] = None
    point_id: Optional[str] = None
    point: Optional[Location] = None
    radius: Optional[float] = None

Python GetUnit DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /GetUnit HTTP/1.1 
Host: api.trackunit.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"id":"String","serialNumber":"String","referenceNumber":"String","categoryId":"String","clientId":"String","groupId":"String","zoneId":"String","pointId":"String","point":{"latitude":0,"longitude":0},"radius":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"list":[{"id":"String","serialNumber":"String","phoneNumber":"String","vehicleType":"String","deviceType":"String","deviceModel":"String","name":"String","displayName":"String","referenceNumber":"String","note":"String","createdAt":"0001-01-01T00:00:00.0000000Z","input1Name":"String","input2Name":"String","input3Name":"String","input4Name":"String","categoryId":"String","clientId":"String","gpsFixTime":"0001-01-01T00:00:00.0000000Z","messageTime":"0001-01-01T00:00:00.0000000Z","location":{"latitude":0,"longitude":0},"altitude":0,"heading":0,"speed":0,"address":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"temperature1":0,"temperature2":0,"gsmLevel":0,"gsmSignalQuality":"String","gpsSignalQuality":"String","batteryLevel":0,"externalPower":0,"preRun1":0,"preRun2":0,"run1":0,"run2":0,"run3":0,"run4":0,"runOdo":0,"preKm":0,"km":0,"input1":false,"input2":false,"input3":false,"input4":false,"input5":false,"input6":false,"input7":false,"input8":false,"input9":false,"input10":false,"output1":false,"output2":false,"output3":false,"output4":false,"output5":false,"analogInput1":0,"analogInput2":0,"analogInput4":0,"input1ChangeCounter":0,"input2ChangeCounter":0,"input3ChangeCounter":0,"input4ChangeCounter":0,"isActive":false,"keyId":"String","isOwn":false,"currentStop":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}