Trackunit API

<back to all web services

GetUnit


// @DataContract
export class Location
{
    // @DataMember
    public latitude: number;

    // @DataMember
    public longitude: number;

    public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Address
{
    // @DataMember
    public country: string;

    // @DataMember
    public zipCode: string;

    // @DataMember
    public city: string;

    // @DataMember
    public streetAddress: string;

    public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Unit
{
    // @DataMember
    public id: string;

    // @DataMember
    public serialNumber: string;

    // @DataMember
    public phoneNumber: string;

    // @DataMember
    public vehicleType: string;

    // @DataMember
    public deviceType: string;

    // @DataMember
    public deviceModel: string;

    // @DataMember
    public name: string;

    // @DataMember
    public displayName: string;

    // @DataMember
    public referenceNumber: string;

    // @DataMember
    public note: string;

    // @DataMember
    public createdAt: string;

    // @DataMember
    public input1Name: string;

    // @DataMember
    public input2Name: string;

    // @DataMember
    public input3Name: string;

    // @DataMember
    public input4Name: string;

    // @DataMember
    public categoryId: string;

    // @DataMember
    public clientId: string;

    // @DataMember
    public gpsFixTime?: string;

    // @DataMember
    public messageTime?: string;

    // @DataMember
    public location: Location;

    // @DataMember
    public altitude?: number;

    // @DataMember
    public heading?: number;

    // @DataMember
    public speed?: number;

    // @DataMember
    public address: Address;

    // @DataMember
    public temperature1?: number;

    // @DataMember
    public temperature2?: number;

    // @DataMember
    public gsmLevel?: number;

    // @DataMember
    public gsmSignalQuality: string;

    // @DataMember
    public gpsSignalQuality: string;

    // @DataMember
    public batteryLevel?: number;

    // @DataMember
    public externalPower?: number;

    // @DataMember
    public preRun1: number;

    // @DataMember
    public preRun2: number;

    // @DataMember
    public run1?: number;

    // @DataMember
    public run2?: number;

    // @DataMember
    public run3?: number;

    // @DataMember
    public run4?: number;

    // @DataMember
    public runOdo?: number;

    // @DataMember
    public preKm: number;

    // @DataMember
    public km?: number;

    // @DataMember
    public input1?: boolean;

    // @DataMember
    public input2?: boolean;

    // @DataMember
    public input3?: boolean;

    // @DataMember
    public input4?: boolean;

    // @DataMember
    public input5?: boolean;

    // @DataMember
    public input6?: boolean;

    // @DataMember
    public input7?: boolean;

    // @DataMember
    public input8?: boolean;

    // @DataMember
    public input9?: boolean;

    // @DataMember
    public input10?: boolean;

    // @DataMember
    public output1?: boolean;

    // @DataMember
    public output2?: boolean;

    // @DataMember
    public output3?: boolean;

    // @DataMember
    public output4?: boolean;

    // @DataMember
    public output5?: boolean;

    // @DataMember
    public analogInput1?: number;

    // @DataMember
    public analogInput2?: number;

    // @DataMember
    public analogInput4?: number;

    // @DataMember
    public input1ChangeCounter?: number;

    // @DataMember
    public input2ChangeCounter?: number;

    // @DataMember
    public input3ChangeCounter?: number;

    // @DataMember
    public input4ChangeCounter?: number;

    // @DataMember
    public isActive: boolean;

    // @DataMember
    public keyId: string;

    // @DataMember
    public isOwn: boolean;

    // @DataMember
    public currentStop?: number;

    public constructor(init?: Partial<Unit>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetUnitResponse
{
    // @DataMember
    public list: Unit[];

    // @DataMember
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetUnitResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetUnit
{
    // @DataMember
    public id: string;

    // @DataMember
    public serialNumber: string;

    // @DataMember
    public referenceNumber: string;

    // @DataMember
    public categoryId: string;

    // @DataMember
    public clientId: string;

    // @DataMember
    public groupId: string;

    // @DataMember
    public zoneId: string;

    // @DataMember
    public pointId: string;

    // @DataMember
    public point: Location;

    // @DataMember
    public radius?: number;

    public constructor(init?: Partial<GetUnit>) { (Object as any).assign(this, init); }
}

TypeScript GetUnit DTOs

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

HTTP + SOAP11

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

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap: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>

</soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap: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>

</soap:Body>
</soap:Envelope>