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}
namespace Trackunit.API

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type Location() = 
        [<DataMember>]
        member val Latitude:Double = new Double() with get,set

        [<DataMember>]
        member val Longitude:Double = new Double() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Address() = 
        [<DataMember>]
        member val Country:String = null with get,set

        [<DataMember>]
        member val ZipCode:String = null with get,set

        [<DataMember>]
        member val City:String = null with get,set

        [<DataMember>]
        member val StreetAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Unit() = 
        [<DataMember>]
        member val Id:String = null with get,set

        [<DataMember>]
        member val SerialNumber:String = null with get,set

        [<DataMember>]
        member val PhoneNumber:String = null with get,set

        [<DataMember>]
        member val VehicleType:String = null with get,set

        [<DataMember>]
        member val DeviceType:String = null with get,set

        [<DataMember>]
        member val DeviceModel:String = null with get,set

        [<DataMember>]
        member val Name:String = null with get,set

        [<DataMember>]
        member val DisplayName:String = null with get,set

        [<DataMember>]
        member val ReferenceNumber:String = null with get,set

        [<DataMember>]
        member val Note:String = null with get,set

        [<DataMember>]
        member val CreatedAt:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val Input1Name:String = null with get,set

        [<DataMember>]
        member val Input2Name:String = null with get,set

        [<DataMember>]
        member val Input3Name:String = null with get,set

        [<DataMember>]
        member val Input4Name:String = null with get,set

        [<DataMember>]
        member val CategoryId:String = null with get,set

        [<DataMember>]
        member val ClientId:String = null with get,set

        [<DataMember>]
        member val GpsFixTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val MessageTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val Location:Location = null with get,set

        [<DataMember>]
        member val Altitude:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val Heading:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val Speed:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val Address:Address = null with get,set

        [<DataMember>]
        member val Temperature1:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val Temperature2:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val GsmLevel:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val GsmSignalQuality:String = null with get,set

        [<DataMember>]
        member val GpsSignalQuality:String = null with get,set

        [<DataMember>]
        member val BatteryLevel:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val ExternalPower:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val PreRun1:Double = new Double() with get,set

        [<DataMember>]
        member val PreRun2:Double = new Double() with get,set

        [<DataMember>]
        member val Run1:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val Run2:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val Run3:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val Run4:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val RunOdo:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val PreKm:Double = new Double() with get,set

        [<DataMember>]
        member val Km:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val Input1:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Input2:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Input3:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Input4:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Input5:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Input6:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Input7:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Input8:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Input9:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Input10:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Output1:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Output2:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Output3:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Output4:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val Output5:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val AnalogInput1:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val AnalogInput2:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val AnalogInput4:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val Input1ChangeCounter:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val Input2ChangeCounter:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val Input3ChangeCounter:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val Input4ChangeCounter:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val IsActive:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val KeyId:String = null with get,set

        [<DataMember>]
        member val IsOwn:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val CurrentStop:Nullable<Double> = new Nullable<Double>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetUnitResponse() = 
        [<DataMember>]
        member val List:ResizeArray<Unit> = null with get,set

        [<DataMember>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetUnit() = 
        [<DataMember>]
        member val Id:String = null with get,set

        [<DataMember>]
        member val SerialNumber:String = null with get,set

        [<DataMember>]
        member val ReferenceNumber:String = null with get,set

        [<DataMember>]
        member val CategoryId:String = null with get,set

        [<DataMember>]
        member val ClientId:String = null with get,set

        [<DataMember>]
        member val GroupId:String = null with get,set

        [<DataMember>]
        member val ZoneId:String = null with get,set

        [<DataMember>]
        member val PointId:String = null with get,set

        [<DataMember>]
        member val Point:Location = null with get,set

        [<DataMember>]
        member val Radius:Nullable<Double> = new Nullable<Double>() with get,set

F# GetUnit DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<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>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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