Trackunit API

<back to all web services

GetAlarmLog

The following routes are available for this service:
GET/alarmLog
GET POST/GetAlarmLog
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 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 Location() = 
        [<DataMember>]
        member val Latitude:Double = new Double() with get,set

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

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

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

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

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

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

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

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

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

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

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

        [<DataMember>]
        member val Recipients:ResizeArray<AlarmRecipient> = null with get,set

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

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

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

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

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

F# GetAlarmLog DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /GetAlarmLog HTTP/1.1 
Host: api.trackunit.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"unitId":"String","dateFrom":"0001-01-01T00:00:00.0000000Z","dateTo":"0001-01-01T00:00:00.0000000Z"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"list":[{"alarmId":"String","unitId":"String","triggeredAt":"0001-01-01T00:00:00.0000000Z","address":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"location":{"latitude":0,"longitude":0},"recipients":[{"contactId":"String","sentVia":"String","phoneNumber":"String","email":"String","delivered":false}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}