Trackunit Developer Hub

Developer Hub

Welcome to our Developer hub.

Here You'll find comprehensive documentation to help you start working with the API's as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

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:

NameData typeUnit of measurementNullabilityNote
idStringN/AUnique identifier.
createdDateTimeUTCFALSE
nameStringN/AFALSEName of alarm.
typeStringN/AFALSE
enabledBoolN/AFALSE
allUnitsBoolN/AFALSE
unitsString[]N/ATRUE
groupsString[]N/ATRUE
emailRecipientsString[]N/ATRUE
systemRecipientsString[]N/ATRUE
smsRecipientsString[]N/ATRUE
temperatureLimitsTemperatureAlarmLimitsCelciusTRUE
ADVoltageLimitsADVoltageAlarmLimitsVoltsTRUE
ADVoltageInputIndexINTN/ATRUE(1,2,4)
thresholdDoubleN/ATRUE
batteryLevelDoublePercent of battery chargeTRUE(0, 100)
radiusDoubleKilometersTRUE
inputIndexINTN/ATRUE
intervalDoubleSecondsTRUE
pointIdStringN/ATRUE
expectedArrivalTimeDateTimeUTCTRUE
powerLevelDoubleVoltsTRUE
weekdaysString[]N/ATRUE
timeStartTimeOfDayLocalTRUE
timeEndTimeOfDayLocalTRUE
zoneIdStringN/ATRUE

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
      }
    }
  ]
}

Updated less than a minute ago

Alarms Collection


Will list all alarms.

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

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.