Trackunit API

<back to all web services

GetAlarm

The following routes are available for this service:
GET POST/GetAlarm
GET POST/GetAlarm/{Id}
GET/Alarm
GET/Alarm/{Id}
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 ADVoltageAlarmLimits
            <DataMember>
            Public Overridable Property ADVoltageLowerLimit As Double?

            <DataMember>
            Public Overridable Property ADVoltageUpperLimit As Double?
        End Class

        <DataContract>
        Public Partial Class Alarm
            <DataMember>
            Public Overridable Property Id As String

            <DataMember>
            Public Overridable Property Created As Date?

            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Type As String

            <DataMember>
            Public Overridable Property Enabled As Boolean?

            <DataMember>
            Public Overridable Property AllUnits As Boolean?

            <DataMember>
            Public Overridable Property Units As String()

            <DataMember>
            Public Overridable Property Groups As String()

            <DataMember>
            Public Overridable Property EmailRecipients As String()

            <DataMember>
            Public Overridable Property SystemRecipients As String()

            <DataMember>
            Public Overridable Property SmsRecipients As String()

            <DataMember>
            Public Overridable Property TemperatureLimits As TemperatureAlarmLimits

            <DataMember>
            Public Overridable Property ADVoltageLimits As ADVoltageAlarmLimits

            <DataMember>
            Public Overridable Property ADVoltageInputIndex As Integer?

            <DataMember>
            Public Overridable Property Threshold As Double?

            <DataMember>
            Public Overridable Property BatteryLevel As Double?

            <DataMember>
            Public Overridable Property Location As Location

            <DataMember>
            Public Overridable Property Radius As Double?

            <DataMember>
            Public Overridable Property InputIndex As Integer?

            <DataMember>
            Public Overridable Property Interval As Double?

            <DataMember>
            Public Overridable Property PointId As String

            <DataMember>
            Public Overridable Property ExpectedArrivalTime As Date?

            <DataMember>
            Public Overridable Property PowerLevel As Double?

            <DataMember>
            Public Overridable Property Weekdays As String()

            <DataMember>
            Public Overridable Property TimeStart As TimeOfDay

            <DataMember>
            Public Overridable Property TimeEnd As TimeOfDay

            <DataMember>
            Public Overridable Property ZoneId As String
        End Class

        <DataContract>
        Public Partial Class GetAlarm
            <DataMember>
            Public Overridable Property Id As String
        End Class

        <DataContract>
        Public Partial Class GetAlarmResponse
            <DataMember>
            Public Overridable Property List As List(Of Alarm)

            <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

        <DataContract>
        Public Partial Class TemperatureAlarmLimits
            <DataMember>
            Public Overridable Property Temperature1LowerLimit As Double?

            <DataMember>
            Public Overridable Property Temperature1UpperLimit As Double?

            <DataMember>
            Public Overridable Property Temperature2LowerLimit As Double?

            <DataMember>
            Public Overridable Property Temperature2UpperLimit As Double?
        End Class

        <DataContract>
        Public Partial Class TimeOfDay
            <DataMember>
            Public Overridable Property Hour As Integer

            <DataMember>
            Public Overridable Property Minute As Integer
        End Class
    End Namespace
End Namespace

VB.NET GetAlarm 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 /GetAlarm HTTP/1.1 
Host: api.trackunit.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"list":[{"id":"String","created":"0001-01-01T00:00:00.0000000Z","name":"String","type":"String","enabled":false,"allUnits":false,"units":["String"],"groups":["String"],"emailRecipients":["String"],"systemRecipients":["String"],"smsRecipients":["String"],"temperatureLimits":{"temperature1LowerLimit":0,"temperature1UpperLimit":0,"temperature2LowerLimit":0,"temperature2UpperLimit":0},"adVoltageLimits":{"adVoltageLowerLimit":0,"adVoltageUpperLimit":0},"adVoltageInputIndex":0,"threshold":0,"batteryLevel":0,"location":{"latitude":0,"longitude":0},"radius":0,"inputIndex":0,"interval":0,"pointId":"String","expectedArrivalTime":"0001-01-01T00:00:00.0000000Z","powerLevel":0,"weekdays":["String"],"timeStart":{"hour":0,"minute":0},"timeEnd":{"hour":0,"minute":0},"zoneId":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}