Trackunit API

<back to all web services

GetUnit

"use strict";
export class Location {
    /** @param {{latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    latitude;
    /** @type {number} */
    longitude;
}
export class Address {
    /** @param {{country?:string,zipCode?:string,city?:string,streetAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    country;
    /** @type {string} */
    zipCode;
    /** @type {string} */
    city;
    /** @type {string} */
    streetAddress;
}
export class Unit {
    /** @param {{id?:string,serialNumber?:string,phoneNumber?:string,vehicleType?:string,deviceType?:string,deviceModel?:string,name?:string,displayName?:string,referenceNumber?:string,note?:string,createdAt?:string,input1Name?:string,input2Name?:string,input3Name?:string,input4Name?:string,categoryId?:string,clientId?:string,gpsFixTime?:string,messageTime?:string,location?:Location,altitude?:number,heading?:number,speed?:number,address?:Address,temperature1?:number,temperature2?:number,gsmLevel?:number,gsmSignalQuality?:string,gpsSignalQuality?:string,batteryLevel?:number,externalPower?:number,preRun1?:number,preRun2?:number,run1?:number,run2?:number,run3?:number,run4?:number,runOdo?:number,preKm?:number,km?:number,input1?:boolean,input2?:boolean,input3?:boolean,input4?:boolean,input5?:boolean,input6?:boolean,input7?:boolean,input8?:boolean,input9?:boolean,input10?:boolean,output1?:boolean,output2?:boolean,output3?:boolean,output4?:boolean,output5?:boolean,analogInput1?:number,analogInput2?:number,analogInput4?:number,input1ChangeCounter?:number,input2ChangeCounter?:number,input3ChangeCounter?:number,input4ChangeCounter?:number,isActive?:boolean,keyId?:string,isOwn?:boolean,currentStop?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    serialNumber;
    /** @type {string} */
    phoneNumber;
    /** @type {string} */
    vehicleType;
    /** @type {string} */
    deviceType;
    /** @type {string} */
    deviceModel;
    /** @type {string} */
    name;
    /** @type {string} */
    displayName;
    /** @type {string} */
    referenceNumber;
    /** @type {string} */
    note;
    /** @type {string} */
    createdAt;
    /** @type {string} */
    input1Name;
    /** @type {string} */
    input2Name;
    /** @type {string} */
    input3Name;
    /** @type {string} */
    input4Name;
    /** @type {string} */
    categoryId;
    /** @type {string} */
    clientId;
    /** @type {?string} */
    gpsFixTime;
    /** @type {?string} */
    messageTime;
    /** @type {Location} */
    location;
    /** @type {?number} */
    altitude;
    /** @type {?number} */
    heading;
    /** @type {?number} */
    speed;
    /** @type {Address} */
    address;
    /** @type {?number} */
    temperature1;
    /** @type {?number} */
    temperature2;
    /** @type {?number} */
    gsmLevel;
    /** @type {string} */
    gsmSignalQuality;
    /** @type {string} */
    gpsSignalQuality;
    /** @type {?number} */
    batteryLevel;
    /** @type {?number} */
    externalPower;
    /** @type {number} */
    preRun1;
    /** @type {number} */
    preRun2;
    /** @type {?number} */
    run1;
    /** @type {?number} */
    run2;
    /** @type {?number} */
    run3;
    /** @type {?number} */
    run4;
    /** @type {?number} */
    runOdo;
    /** @type {number} */
    preKm;
    /** @type {?number} */
    km;
    /** @type {?boolean} */
    input1;
    /** @type {?boolean} */
    input2;
    /** @type {?boolean} */
    input3;
    /** @type {?boolean} */
    input4;
    /** @type {?boolean} */
    input5;
    /** @type {?boolean} */
    input6;
    /** @type {?boolean} */
    input7;
    /** @type {?boolean} */
    input8;
    /** @type {?boolean} */
    input9;
    /** @type {?boolean} */
    input10;
    /** @type {?boolean} */
    output1;
    /** @type {?boolean} */
    output2;
    /** @type {?boolean} */
    output3;
    /** @type {?boolean} */
    output4;
    /** @type {?boolean} */
    output5;
    /** @type {?number} */
    analogInput1;
    /** @type {?number} */
    analogInput2;
    /** @type {?number} */
    analogInput4;
    /** @type {?number} */
    input1ChangeCounter;
    /** @type {?number} */
    input2ChangeCounter;
    /** @type {?number} */
    input3ChangeCounter;
    /** @type {?number} */
    input4ChangeCounter;
    /** @type {boolean} */
    isActive;
    /** @type {string} */
    keyId;
    /** @type {boolean} */
    isOwn;
    /** @type {?number} */
    currentStop;
}
export class GetUnitResponse {
    /** @param {{list?:Unit[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Unit[]} */
    list;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetUnit {
    /** @param {{id?:string,serialNumber?:string,referenceNumber?:string,categoryId?:string,clientId?:string,groupId?:string,zoneId?:string,pointId?:string,point?:Location,radius?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    serialNumber;
    /** @type {string} */
    referenceNumber;
    /** @type {string} */
    categoryId;
    /** @type {string} */
    clientId;
    /** @type {string} */
    groupId;
    /** @type {string} */
    zoneId;
    /** @type {string} */
    pointId;
    /** @type {Location} */
    point;
    /** @type {?number} */
    radius;
}

JavaScript GetUnit DTOs

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

HTTP + SOAP12

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

POST /soap12 HTTP/1.1 
Host: api.trackunit.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

<GetUnit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <CategoryId>String</CategoryId>
  <ClientId>String</ClientId>
  <GroupId>String</GroupId>
  <Id>String</Id>
  <Point>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
  </Point>
  <PointId>String</PointId>
  <Radius>0</Radius>
  <ReferenceNumber>String</ReferenceNumber>
  <SerialNumber>String</SerialNumber>
  <ZoneId>String</ZoneId>
</GetUnit>

</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

<GetUnitResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <List>
    <Unit>
      <Address>
        <City>String</City>
        <Country>String</Country>
        <StreetAddress>String</StreetAddress>
        <ZipCode>String</ZipCode>
      </Address>
      <Altitude>0</Altitude>
      <AnalogInput1>0</AnalogInput1>
      <AnalogInput2>0</AnalogInput2>
      <AnalogInput4>0</AnalogInput4>
      <BatteryLevel>0</BatteryLevel>
      <CategoryId>String</CategoryId>
      <ClientId>String</ClientId>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CurrentStop>0</CurrentStop>
      <DeviceModel>String</DeviceModel>
      <DeviceType>String</DeviceType>
      <DisplayName>String</DisplayName>
      <ExternalPower>0</ExternalPower>
      <GpsFixTime>0001-01-01T00:00:00</GpsFixTime>
      <GpsSignalQuality>String</GpsSignalQuality>
      <GsmLevel>0</GsmLevel>
      <GsmSignalQuality>String</GsmSignalQuality>
      <Heading>0</Heading>
      <Id>String</Id>
      <Input1>false</Input1>
      <Input10>false</Input10>
      <Input1ChangeCounter>0</Input1ChangeCounter>
      <Input1Name>String</Input1Name>
      <Input2>false</Input2>
      <Input2ChangeCounter>0</Input2ChangeCounter>
      <Input2Name>String</Input2Name>
      <Input3>false</Input3>
      <Input3ChangeCounter>0</Input3ChangeCounter>
      <Input3Name>String</Input3Name>
      <Input4>false</Input4>
      <Input4ChangeCounter>0</Input4ChangeCounter>
      <Input4Name>String</Input4Name>
      <Input5>false</Input5>
      <Input6>false</Input6>
      <Input7>false</Input7>
      <Input8>false</Input8>
      <Input9>false</Input9>
      <IsActive>false</IsActive>
      <IsOwn>false</IsOwn>
      <KeyId>String</KeyId>
      <Km>0</Km>
      <Location>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
      </Location>
      <MessageTime>0001-01-01T00:00:00</MessageTime>
      <Name>String</Name>
      <Note>String</Note>
      <Output1>false</Output1>
      <Output2>false</Output2>
      <Output3>false</Output3>
      <Output4>false</Output4>
      <Output5>false</Output5>
      <PhoneNumber>String</PhoneNumber>
      <PreKm>0</PreKm>
      <PreRun1>0</PreRun1>
      <PreRun2>0</PreRun2>
      <ReferenceNumber>String</ReferenceNumber>
      <Run1>0</Run1>
      <Run2>0</Run2>
      <Run3>0</Run3>
      <Run4>0</Run4>
      <RunOdo>0</RunOdo>
      <SerialNumber>String</SerialNumber>
      <Speed>0</Speed>
      <Temperature1>0</Temperature1>
      <Temperature2>0</Temperature2>
      <VehicleType>String</VehicleType>
    </Unit>
  </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>
</GetUnitResponse>

</soap12:Body>
</soap12:Envelope>