Trackunit API

<back to all web services

GetUnit

import Foundation
import ServiceStack

// @DataContract
public class GetUnit : Codable
{
    // @DataMember
    public var id:String

    // @DataMember
    public var serialNumber:String

    // @DataMember
    public var referenceNumber:String

    // @DataMember
    public var categoryId:String

    // @DataMember
    public var clientId:String

    // @DataMember
    public var groupId:String

    // @DataMember
    public var zoneId:String

    // @DataMember
    public var pointId:String

    // @DataMember
    public var point:Location

    // @DataMember
    public var radius:Double?

    required public init(){}
}

// @DataContract
public class Location : Codable
{
    // @DataMember
    public var latitude:Double

    // @DataMember
    public var longitude:Double

    required public init(){}
}

// @DataContract
public class GetUnitResponse : Codable
{
    // @DataMember
    public var list:[Unit]

    // @DataMember
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class Unit : Codable
{
    // @DataMember
    public var id:String

    // @DataMember
    public var serialNumber:String

    // @DataMember
    public var phoneNumber:String

    // @DataMember
    public var vehicleType:String

    // @DataMember
    public var deviceType:String

    // @DataMember
    public var deviceModel:String

    // @DataMember
    public var name:String

    // @DataMember
    public var displayName:String

    // @DataMember
    public var referenceNumber:String

    // @DataMember
    public var note:String

    // @DataMember
    public var createdAt:Date

    // @DataMember
    public var input1Name:String

    // @DataMember
    public var input2Name:String

    // @DataMember
    public var input3Name:String

    // @DataMember
    public var input4Name:String

    // @DataMember
    public var categoryId:String

    // @DataMember
    public var clientId:String

    // @DataMember
    public var gpsFixTime:Date?

    // @DataMember
    public var messageTime:Date?

    // @DataMember
    public var location:Location

    // @DataMember
    public var altitude:Double?

    // @DataMember
    public var heading:Int?

    // @DataMember
    public var speed:Double?

    // @DataMember
    public var address:Address

    // @DataMember
    public var temperature1:Double?

    // @DataMember
    public var temperature2:Double?

    // @DataMember
    public var gsmLevel:Double?

    // @DataMember
    public var gsmSignalQuality:String

    // @DataMember
    public var gpsSignalQuality:String

    // @DataMember
    public var batteryLevel:Double?

    // @DataMember
    public var externalPower:Double?

    // @DataMember
    public var preRun1:Double

    // @DataMember
    public var preRun2:Double

    // @DataMember
    public var run1:Double?

    // @DataMember
    public var run2:Double?

    // @DataMember
    public var run3:Double?

    // @DataMember
    public var run4:Double?

    // @DataMember
    public var runOdo:Double?

    // @DataMember
    public var preKm:Double

    // @DataMember
    public var km:Double?

    // @DataMember
    public var input1:Bool?

    // @DataMember
    public var input2:Bool?

    // @DataMember
    public var input3:Bool?

    // @DataMember
    public var input4:Bool?

    // @DataMember
    public var input5:Bool?

    // @DataMember
    public var input6:Bool?

    // @DataMember
    public var input7:Bool?

    // @DataMember
    public var input8:Bool?

    // @DataMember
    public var input9:Bool?

    // @DataMember
    public var input10:Bool?

    // @DataMember
    public var output1:Bool?

    // @DataMember
    public var output2:Bool?

    // @DataMember
    public var output3:Bool?

    // @DataMember
    public var output4:Bool?

    // @DataMember
    public var output5:Bool?

    // @DataMember
    public var analogInput1:Double?

    // @DataMember
    public var analogInput2:Double?

    // @DataMember
    public var analogInput4:Double?

    // @DataMember
    public var input1ChangeCounter:Int?

    // @DataMember
    public var input2ChangeCounter:Int?

    // @DataMember
    public var input3ChangeCounter:Int?

    // @DataMember
    public var input4ChangeCounter:Int?

    // @DataMember
    public var isActive:Bool

    // @DataMember
    public var keyId:String

    // @DataMember
    public var isOwn:Bool

    // @DataMember
    public var currentStop:Double?

    required public init(){}
}

// @DataContract
public class Address : Codable
{
    // @DataMember
    public var country:String

    // @DataMember
    public var zipCode:String

    // @DataMember
    public var city:String

    // @DataMember
    public var streetAddress:String

    required public init(){}
}

Swift 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>