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 .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"keyId":"String","from":"0001-01-01T00:00:00.0000000Z","to":"0001-01-01T00:00:00.0000000Z"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"list":[{"unitId":"String","time":"0001-01-01T00:00:00.0000000Z","location":{"latitude":0,"longitude":0},"address":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"heading":0,"speed":0,"km":0,"run1":0,"run2":0,"runOdo":0,"temperature1":0,"temperature2":0,"input1":false,"input2":false,"output3":false,"batteryLevel":0,"externalPower":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}