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 'package:servicestack/servicestack.dart';

// @DataContract
class Location implements IConvertible
{
    // @DataMember
    double? latitude;

    // @DataMember
    double? longitude;

    Location({this.latitude,this.longitude});
    Location.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        latitude = JsonConverters.toDouble(json['latitude']);
        longitude = JsonConverters.toDouble(json['longitude']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'latitude': latitude,
        'longitude': longitude
    };

    getTypeName() => "Location";
    TypeContext? context = _ctx;
}

// @DataContract
class Address implements IConvertible
{
    // @DataMember
    String? country;

    // @DataMember
    String? zipCode;

    // @DataMember
    String? city;

    // @DataMember
    String? streetAddress;

    Address({this.country,this.zipCode,this.city,this.streetAddress});
    Address.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        country = json['country'];
        zipCode = json['zipCode'];
        city = json['city'];
        streetAddress = json['streetAddress'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'country': country,
        'zipCode': zipCode,
        'city': city,
        'streetAddress': streetAddress
    };

    getTypeName() => "Address";
    TypeContext? context = _ctx;
}

// @DataContract
class Unit implements IConvertible
{
    // @DataMember
    String? id;

    // @DataMember
    String? serialNumber;

    // @DataMember
    String? phoneNumber;

    // @DataMember
    String? vehicleType;

    // @DataMember
    String? deviceType;

    // @DataMember
    String? deviceModel;

    // @DataMember
    String? name;

    // @DataMember
    String? displayName;

    // @DataMember
    String? referenceNumber;

    // @DataMember
    String? note;

    // @DataMember
    DateTime? createdAt;

    // @DataMember
    String? input1Name;

    // @DataMember
    String? input2Name;

    // @DataMember
    String? input3Name;

    // @DataMember
    String? input4Name;

    // @DataMember
    String? categoryId;

    // @DataMember
    String? clientId;

    // @DataMember
    DateTime? gpsFixTime;

    // @DataMember
    DateTime? messageTime;

    // @DataMember
    Location? location;

    // @DataMember
    double? altitude;

    // @DataMember
    int? heading;

    // @DataMember
    double? speed;

    // @DataMember
    Address? address;

    // @DataMember
    double? temperature1;

    // @DataMember
    double? temperature2;

    // @DataMember
    double? gsmLevel;

    // @DataMember
    String? gsmSignalQuality;

    // @DataMember
    String? gpsSignalQuality;

    // @DataMember
    double? batteryLevel;

    // @DataMember
    double? externalPower;

    // @DataMember
    double? preRun1;

    // @DataMember
    double? preRun2;

    // @DataMember
    double? run1;

    // @DataMember
    double? run2;

    // @DataMember
    double? run3;

    // @DataMember
    double? run4;

    // @DataMember
    double? runOdo;

    // @DataMember
    double? preKm;

    // @DataMember
    double? km;

    // @DataMember
    bool? input1;

    // @DataMember
    bool? input2;

    // @DataMember
    bool? input3;

    // @DataMember
    bool? input4;

    // @DataMember
    bool? input5;

    // @DataMember
    bool? input6;

    // @DataMember
    bool? input7;

    // @DataMember
    bool? input8;

    // @DataMember
    bool? input9;

    // @DataMember
    bool? input10;

    // @DataMember
    bool? output1;

    // @DataMember
    bool? output2;

    // @DataMember
    bool? output3;

    // @DataMember
    bool? output4;

    // @DataMember
    bool? output5;

    // @DataMember
    double? analogInput1;

    // @DataMember
    double? analogInput2;

    // @DataMember
    double? analogInput4;

    // @DataMember
    int? input1ChangeCounter;

    // @DataMember
    int? input2ChangeCounter;

    // @DataMember
    int? input3ChangeCounter;

    // @DataMember
    int? input4ChangeCounter;

    // @DataMember
    bool? isActive;

    // @DataMember
    String? keyId;

    // @DataMember
    bool? isOwn;

    // @DataMember
    double? currentStop;

    Unit({this.id,this.serialNumber,this.phoneNumber,this.vehicleType,this.deviceType,this.deviceModel,this.name,this.displayName,this.referenceNumber,this.note,this.createdAt,this.input1Name,this.input2Name,this.input3Name,this.input4Name,this.categoryId,this.clientId,this.gpsFixTime,this.messageTime,this.location,this.altitude,this.heading,this.speed,this.address,this.temperature1,this.temperature2,this.gsmLevel,this.gsmSignalQuality,this.gpsSignalQuality,this.batteryLevel,this.externalPower,this.preRun1,this.preRun2,this.run1,this.run2,this.run3,this.run4,this.runOdo,this.preKm,this.km,this.input1,this.input2,this.input3,this.input4,this.input5,this.input6,this.input7,this.input8,this.input9,this.input10,this.output1,this.output2,this.output3,this.output4,this.output5,this.analogInput1,this.analogInput2,this.analogInput4,this.input1ChangeCounter,this.input2ChangeCounter,this.input3ChangeCounter,this.input4ChangeCounter,this.isActive,this.keyId,this.isOwn,this.currentStop});
    Unit.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        serialNumber = json['serialNumber'];
        phoneNumber = json['phoneNumber'];
        vehicleType = json['vehicleType'];
        deviceType = json['deviceType'];
        deviceModel = json['deviceModel'];
        name = json['name'];
        displayName = json['displayName'];
        referenceNumber = json['referenceNumber'];
        note = json['note'];
        createdAt = JsonConverters.fromJson(json['createdAt'],'DateTime',context!);
        input1Name = json['input1Name'];
        input2Name = json['input2Name'];
        input3Name = json['input3Name'];
        input4Name = json['input4Name'];
        categoryId = json['categoryId'];
        clientId = json['clientId'];
        gpsFixTime = JsonConverters.fromJson(json['gpsFixTime'],'DateTime',context!);
        messageTime = JsonConverters.fromJson(json['messageTime'],'DateTime',context!);
        location = JsonConverters.fromJson(json['location'],'Location',context!);
        altitude = JsonConverters.toDouble(json['altitude']);
        heading = json['heading'];
        speed = JsonConverters.toDouble(json['speed']);
        address = JsonConverters.fromJson(json['address'],'Address',context!);
        temperature1 = JsonConverters.toDouble(json['temperature1']);
        temperature2 = JsonConverters.toDouble(json['temperature2']);
        gsmLevel = JsonConverters.toDouble(json['gsmLevel']);
        gsmSignalQuality = json['gsmSignalQuality'];
        gpsSignalQuality = json['gpsSignalQuality'];
        batteryLevel = JsonConverters.toDouble(json['batteryLevel']);
        externalPower = JsonConverters.toDouble(json['externalPower']);
        preRun1 = JsonConverters.toDouble(json['preRun1']);
        preRun2 = JsonConverters.toDouble(json['preRun2']);
        run1 = JsonConverters.toDouble(json['run1']);
        run2 = JsonConverters.toDouble(json['run2']);
        run3 = JsonConverters.toDouble(json['run3']);
        run4 = JsonConverters.toDouble(json['run4']);
        runOdo = JsonConverters.toDouble(json['runOdo']);
        preKm = JsonConverters.toDouble(json['preKm']);
        km = JsonConverters.toDouble(json['km']);
        input1 = json['input1'];
        input2 = json['input2'];
        input3 = json['input3'];
        input4 = json['input4'];
        input5 = json['input5'];
        input6 = json['input6'];
        input7 = json['input7'];
        input8 = json['input8'];
        input9 = json['input9'];
        input10 = json['input10'];
        output1 = json['output1'];
        output2 = json['output2'];
        output3 = json['output3'];
        output4 = json['output4'];
        output5 = json['output5'];
        analogInput1 = JsonConverters.toDouble(json['analogInput1']);
        analogInput2 = JsonConverters.toDouble(json['analogInput2']);
        analogInput4 = JsonConverters.toDouble(json['analogInput4']);
        input1ChangeCounter = json['input1ChangeCounter'];
        input2ChangeCounter = json['input2ChangeCounter'];
        input3ChangeCounter = json['input3ChangeCounter'];
        input4ChangeCounter = json['input4ChangeCounter'];
        isActive = json['isActive'];
        keyId = json['keyId'];
        isOwn = json['isOwn'];
        currentStop = JsonConverters.toDouble(json['currentStop']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'serialNumber': serialNumber,
        'phoneNumber': phoneNumber,
        'vehicleType': vehicleType,
        'deviceType': deviceType,
        'deviceModel': deviceModel,
        'name': name,
        'displayName': displayName,
        'referenceNumber': referenceNumber,
        'note': note,
        'createdAt': JsonConverters.toJson(createdAt,'DateTime',context!),
        'input1Name': input1Name,
        'input2Name': input2Name,
        'input3Name': input3Name,
        'input4Name': input4Name,
        'categoryId': categoryId,
        'clientId': clientId,
        'gpsFixTime': JsonConverters.toJson(gpsFixTime,'DateTime',context!),
        'messageTime': JsonConverters.toJson(messageTime,'DateTime',context!),
        'location': JsonConverters.toJson(location,'Location',context!),
        'altitude': altitude,
        'heading': heading,
        'speed': speed,
        'address': JsonConverters.toJson(address,'Address',context!),
        'temperature1': temperature1,
        'temperature2': temperature2,
        'gsmLevel': gsmLevel,
        'gsmSignalQuality': gsmSignalQuality,
        'gpsSignalQuality': gpsSignalQuality,
        'batteryLevel': batteryLevel,
        'externalPower': externalPower,
        'preRun1': preRun1,
        'preRun2': preRun2,
        'run1': run1,
        'run2': run2,
        'run3': run3,
        'run4': run4,
        'runOdo': runOdo,
        'preKm': preKm,
        'km': km,
        'input1': input1,
        'input2': input2,
        'input3': input3,
        'input4': input4,
        'input5': input5,
        'input6': input6,
        'input7': input7,
        'input8': input8,
        'input9': input9,
        'input10': input10,
        'output1': output1,
        'output2': output2,
        'output3': output3,
        'output4': output4,
        'output5': output5,
        'analogInput1': analogInput1,
        'analogInput2': analogInput2,
        'analogInput4': analogInput4,
        'input1ChangeCounter': input1ChangeCounter,
        'input2ChangeCounter': input2ChangeCounter,
        'input3ChangeCounter': input3ChangeCounter,
        'input4ChangeCounter': input4ChangeCounter,
        'isActive': isActive,
        'keyId': keyId,
        'isOwn': isOwn,
        'currentStop': currentStop
    };

    getTypeName() => "Unit";
    TypeContext? context = _ctx;
}

// @DataContract
class GetUnitResponse implements IConvertible
{
    // @DataMember
    List<Unit>? list;

    // @DataMember
    ResponseStatus? responseStatus;

    GetUnitResponse({this.list,this.responseStatus});
    GetUnitResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        list = JsonConverters.fromJson(json['list'],'List<Unit>',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'list': JsonConverters.toJson(list,'List<Unit>',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetUnitResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class GetUnit implements IConvertible
{
    // @DataMember
    String? id;

    // @DataMember
    String? serialNumber;

    // @DataMember
    String? referenceNumber;

    // @DataMember
    String? categoryId;

    // @DataMember
    String? clientId;

    // @DataMember
    String? groupId;

    // @DataMember
    String? zoneId;

    // @DataMember
    String? pointId;

    // @DataMember
    Location? point;

    // @DataMember
    double? radius;

    GetUnit({this.id,this.serialNumber,this.referenceNumber,this.categoryId,this.clientId,this.groupId,this.zoneId,this.pointId,this.point,this.radius});
    GetUnit.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        serialNumber = json['serialNumber'];
        referenceNumber = json['referenceNumber'];
        categoryId = json['categoryId'];
        clientId = json['clientId'];
        groupId = json['groupId'];
        zoneId = json['zoneId'];
        pointId = json['pointId'];
        point = JsonConverters.fromJson(json['point'],'Location',context!);
        radius = JsonConverters.toDouble(json['radius']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'serialNumber': serialNumber,
        'referenceNumber': referenceNumber,
        'categoryId': categoryId,
        'clientId': clientId,
        'groupId': groupId,
        'zoneId': zoneId,
        'pointId': pointId,
        'point': JsonConverters.toJson(point,'Location',context!),
        'radius': radius
    };

    getTypeName() => "GetUnit";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.trackunit.com', types: <String, TypeInfo> {
    'Location': TypeInfo(TypeOf.Class, create:() => Location()),
    'Address': TypeInfo(TypeOf.Class, create:() => Address()),
    'Unit': TypeInfo(TypeOf.Class, create:() => Unit()),
    'GetUnitResponse': TypeInfo(TypeOf.Class, create:() => GetUnitResponse()),
    'List<Unit>': TypeInfo(TypeOf.Class, create:() => <Unit>[]),
    'GetUnit': TypeInfo(TypeOf.Class, create:() => GetUnit()),
});

Dart GetUnit 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 /GetUnit HTTP/1.1 
Host: api.trackunit.com 
Accept: application/json
Content-Type: application/json
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: application/json
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"}}}