Trackunit API

<back to all web services

GetReportKeyHistory

The following routes are available for this service:
GET POST/report/keyhistory
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 KeyHistory() = 
        [<DataMember>]
        member val UnitId:String = null with get,set

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

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

        [<DataMember>]
        member val Address:Address = null 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 Km:Nullable<Double> = new Nullable<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 RunOdo:Nullable<Double> = new Nullable<Double>() 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 Input1:Nullable<Boolean> = new Nullable<Boolean>() with get,set

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

        [<DataMember>]
        member val Output3:Nullable<Boolean> = new Nullable<Boolean>() 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

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

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

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

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

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

F# GetReportKeyHistory 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 /report/keyhistory HTTP/1.1 
Host: api.trackunit.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetReportKeyHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <From>0001-01-01T00:00:00</From>
  <KeyId>String</KeyId>
  <To>0001-01-01T00:00:00</To>
</GetReportKeyHistory>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetReportKeyHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <List>
    <KeyHistory>
      <Address>
        <City>String</City>
        <Country>String</Country>
        <StreetAddress>String</StreetAddress>
        <ZipCode>String</ZipCode>
      </Address>
      <BatteryLevel>0</BatteryLevel>
      <ExternalPower>0</ExternalPower>
      <Heading>0</Heading>
      <Input1>false</Input1>
      <Input2>false</Input2>
      <Km>0</Km>
      <Location>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
      </Location>
      <Output3>false</Output3>
      <Run1>0</Run1>
      <Run2>0</Run2>
      <RunOdo>0</RunOdo>
      <Speed>0</Speed>
      <Temperature1>0</Temperature1>
      <Temperature2>0</Temperature2>
      <Time>0001-01-01T00:00:00</Time>
      <UnitId>String</UnitId>
    </KeyHistory>
  </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>
</GetReportKeyHistoryResponse>