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}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Trackunit.API;

namespace Trackunit.API
{
    [DataContract]
    public partial class Address
    {
        [DataMember]
        public virtual string Country { get; set; }

        [DataMember]
        public virtual string ZipCode { get; set; }

        [DataMember]
        public virtual string City { get; set; }

        [DataMember]
        public virtual string StreetAddress { get; set; }
    }

    [DataContract]
    public partial class GetUnit
    {
        [DataMember]
        public virtual string Id { get; set; }

        [DataMember]
        public virtual string SerialNumber { get; set; }

        [DataMember]
        public virtual string ReferenceNumber { get; set; }

        [DataMember]
        public virtual string CategoryId { get; set; }

        [DataMember]
        public virtual string ClientId { get; set; }

        [DataMember]
        public virtual string GroupId { get; set; }

        [DataMember]
        public virtual string ZoneId { get; set; }

        [DataMember]
        public virtual string PointId { get; set; }

        [DataMember]
        public virtual Location Point { get; set; }

        [DataMember]
        public virtual double? Radius { get; set; }
    }

    [DataContract]
    public partial class GetUnitResponse
    {
        [DataMember]
        public virtual List<Unit> List { get; set; }

        [DataMember]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public partial class Location
    {
        [DataMember]
        public virtual double Latitude { get; set; }

        [DataMember]
        public virtual double Longitude { get; set; }
    }

    [DataContract]
    public partial class Unit
    {
        [DataMember]
        public virtual string Id { get; set; }

        [DataMember]
        public virtual string SerialNumber { get; set; }

        [DataMember]
        public virtual string PhoneNumber { get; set; }

        [DataMember]
        public virtual string VehicleType { get; set; }

        [DataMember]
        public virtual string DeviceType { get; set; }

        [DataMember]
        public virtual string DeviceModel { get; set; }

        [DataMember]
        public virtual string Name { get; set; }

        [DataMember]
        public virtual string DisplayName { get; set; }

        [DataMember]
        public virtual string ReferenceNumber { get; set; }

        [DataMember]
        public virtual string Note { get; set; }

        [DataMember]
        public virtual DateTime CreatedAt { get; set; }

        [DataMember]
        public virtual string Input1Name { get; set; }

        [DataMember]
        public virtual string Input2Name { get; set; }

        [DataMember]
        public virtual string Input3Name { get; set; }

        [DataMember]
        public virtual string Input4Name { get; set; }

        [DataMember]
        public virtual string CategoryId { get; set; }

        [DataMember]
        public virtual string ClientId { get; set; }

        [DataMember]
        public virtual DateTime? GpsFixTime { get; set; }

        [DataMember]
        public virtual DateTime? MessageTime { get; set; }

        [DataMember]
        public virtual Location Location { get; set; }

        [DataMember]
        public virtual double? Altitude { get; set; }

        [DataMember]
        public virtual int? Heading { get; set; }

        [DataMember]
        public virtual double? Speed { get; set; }

        [DataMember]
        public virtual Address Address { get; set; }

        [DataMember]
        public virtual double? Temperature1 { get; set; }

        [DataMember]
        public virtual double? Temperature2 { get; set; }

        [DataMember]
        public virtual double? GsmLevel { get; set; }

        [DataMember]
        public virtual string GsmSignalQuality { get; set; }

        [DataMember]
        public virtual string GpsSignalQuality { get; set; }

        [DataMember]
        public virtual double? BatteryLevel { get; set; }

        [DataMember]
        public virtual double? ExternalPower { get; set; }

        [DataMember]
        public virtual double PreRun1 { get; set; }

        [DataMember]
        public virtual double PreRun2 { get; set; }

        [DataMember]
        public virtual double? Run1 { get; set; }

        [DataMember]
        public virtual double? Run2 { get; set; }

        [DataMember]
        public virtual double? Run3 { get; set; }

        [DataMember]
        public virtual double? Run4 { get; set; }

        [DataMember]
        public virtual double? RunOdo { get; set; }

        [DataMember]
        public virtual double PreKm { get; set; }

        [DataMember]
        public virtual double? Km { get; set; }

        [DataMember]
        public virtual bool? Input1 { get; set; }

        [DataMember]
        public virtual bool? Input2 { get; set; }

        [DataMember]
        public virtual bool? Input3 { get; set; }

        [DataMember]
        public virtual bool? Input4 { get; set; }

        [DataMember]
        public virtual bool? Input5 { get; set; }

        [DataMember]
        public virtual bool? Input6 { get; set; }

        [DataMember]
        public virtual bool? Input7 { get; set; }

        [DataMember]
        public virtual bool? Input8 { get; set; }

        [DataMember]
        public virtual bool? Input9 { get; set; }

        [DataMember]
        public virtual bool? Input10 { get; set; }

        [DataMember]
        public virtual bool? Output1 { get; set; }

        [DataMember]
        public virtual bool? Output2 { get; set; }

        [DataMember]
        public virtual bool? Output3 { get; set; }

        [DataMember]
        public virtual bool? Output4 { get; set; }

        [DataMember]
        public virtual bool? Output5 { get; set; }

        [DataMember]
        public virtual double? AnalogInput1 { get; set; }

        [DataMember]
        public virtual double? AnalogInput2 { get; set; }

        [DataMember]
        public virtual double? AnalogInput4 { get; set; }

        [DataMember]
        public virtual int? Input1ChangeCounter { get; set; }

        [DataMember]
        public virtual int? Input2ChangeCounter { get; set; }

        [DataMember]
        public virtual int? Input3ChangeCounter { get; set; }

        [DataMember]
        public virtual int? Input4ChangeCounter { get; set; }

        [DataMember]
        public virtual bool IsActive { get; set; }

        [DataMember]
        public virtual string KeyId { get; set; }

        [DataMember]
        public virtual bool IsOwn { get; set; }

        [DataMember]
        public virtual double? CurrentStop { get; set; }
    }

}

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