Trackunit API

<back to all web services

GetAlarmLog

The following routes are available for this service:
GET/alarmLog
GET POST/GetAlarmLog
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Trackunit.API

Namespace Global

    Namespace Trackunit.API

        <DataContract>
        Public Partial Class Address
            <DataMember>
            Public Overridable Property Country As String

            <DataMember>
            Public Overridable Property ZipCode As String

            <DataMember>
            Public Overridable Property City As String

            <DataMember>
            Public Overridable Property StreetAddress As String
        End Class

        <DataContract>
        Public Partial Class AlarmLog
            <DataMember>
            Public Overridable Property AlarmId As String

            <DataMember>
            Public Overridable Property UnitId As String

            <DataMember>
            Public Overridable Property TriggeredAt As Date

            <DataMember>
            Public Overridable Property Address As Address

            <DataMember>
            Public Overridable Property Location As Location

            <DataMember>
            Public Overridable Property Recipients As List(Of AlarmRecipient)
        End Class

        <DataContract>
        Public Partial Class AlarmRecipient
            <DataMember>
            Public Overridable Property ContactId As String

            <DataMember>
            Public Overridable Property SentVia As String

            <DataMember>
            Public Overridable Property PhoneNumber As String

            <DataMember>
            Public Overridable Property Email As String

            <DataMember>
            Public Overridable Property Delivered As Boolean
        End Class

        <DataContract>
        Public Partial Class GetAlarmLog
            <DataMember>
            Public Overridable Property UnitId As String

            <DataMember>
            Public Overridable Property DateFrom As Date?

            <DataMember>
            Public Overridable Property DateTo As Date?
        End Class

        <DataContract>
        Public Partial Class GetAlarmLogResponse
            <DataMember>
            Public Overridable Property List As List(Of AlarmLog)

            <DataMember>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        <DataContract>
        Public Partial Class Location
            <DataMember>
            Public Overridable Property Latitude As Double

            <DataMember>
            Public Overridable Property Longitude As Double
        End Class
    End Namespace
End Namespace

VB.NET GetAlarmLog 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 /GetAlarmLog HTTP/1.1 
Host: api.trackunit.com 
Accept: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
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"}}}