Alarms Collection

Will list all alarms.

URL Structure is:
https://api.trackunit.com/public/Alarm

GetAlarms

Columns

Refer to the following table for description of columns:

Name

Data type

Unit of measurement

Nullability

Note

id

String

N/A

Unique identifier.

created

DateTime

UTC

FALSE

name

String

N/A

FALSE

Name of alarm.

type

String

N/A

FALSE

enabled

Bool

N/A

FALSE

allUnits

Bool

N/A

FALSE

units

String[]

N/A

TRUE

groups

String[]

N/A

TRUE

emailRecipients

String[]

N/A

TRUE

systemRecipients

String[]

N/A

TRUE

smsRecipients

String[]

N/A

TRUE

temperatureLimits

TemperatureAlarmLimits

Celcius

TRUE

ADVoltageLimits

ADVoltageAlarmLimits

Volts

TRUE

ADVoltageInputIndex

INT

N/A

TRUE

(1,2,4)

threshold

Double

N/A

TRUE

batteryLevel

Double

Percent of battery charge

TRUE

(0, 100)

radius

Double

Kilometers

TRUE

inputIndex

INT

N/A

TRUE

interval

Double

Seconds

TRUE

pointId

String

N/A

TRUE

expectedArrivalTime

DateTime

UTC

TRUE

powerLevel

Double

Volts

TRUE

weekdays

String[]

N/A

TRUE

timeStart

TimeOfDay

Local

TRUE

timeEnd

TimeOfDay

Local

TRUE

zoneId

String

N/A

TRUE

Request (example)

{}

Response

{
  "list": [
    {
      "id": "70329",
      "created": "2014-03-03T13:51:15.7166931Z",
      "name": "Zone alarm, Pauliström",
      "type": "ByZoneEnter",
      "enabled": true,
      "allUnits": true,
      "units": [],
      "groups": [],
      "emailRecipients": [
        "29829"
      ],
      "systemRecipients": [],
      "smsRecipients": [],
      "zoneId": "6295"
    },
    {
      "id": "70356",
      "created": "2014-03-04T08:07:08.0332907Z",
      "name": "Low battery alarm",
      "type": "ByBatteryLevel",
      "enabled": true,
      "allUnits": true,
      "units": [],
      "groups": [],
      "emailRecipients": [
        "29830"
      ],
      "systemRecipients": [],
      "smsRecipients": [],
      "batteryLevel": 30
    },
    {
      "id": "70357",
      "created": "2014-03-04T08:41:08.6614280Z",
      "name": "Weekend alarm",
      "type": "ByWorkTime",
      "enabled": true,
      "allUnits": false,
      "units": [],
      "groups": [
        "8819"
      ],
      "emailRecipients": [
        "29831"
      ],
      "systemRecipients": [],
      "smsRecipients": [],
      "weekdays": [
        "Sunday"
      ],
      "timeStart": {
        "hour": 0,
        "minute": 0
      },
      "timeEnd": {
        "hour": 23,
        "minute": 45
      }
    }
  ]
}