{"_id":"57161fac893cbe0e002d7587","parentDoc":null,"category":{"_id":"5716136a893cbe0e002d7552","__v":0,"project":"56d54a77075dfa0b00be98d5","version":"56d54a77075dfa0b00be98d8","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-04-19T11:15:54.714Z","from_sync":false,"order":9,"slug":"alerting","title":"Alerting"},"project":"56d54a77075dfa0b00be98d5","__v":6,"githubsync":"","user":"56d548ba075dfa0b00be98d2","version":{"_id":"56d54a77075dfa0b00be98d8","__v":13,"project":"56d54a77075dfa0b00be98d5","createdAt":"2016-03-01T07:53:27.479Z","releaseDate":"2016-03-01T07:53:27.479Z","categories":["56d54a78075dfa0b00be98d9","56d6bbf046d19315000f8ea2","56d6bbfc46d19315000f8ea3","570cefd98da5b62b00d57e3c","571491a74007610e00c803ae","5714dcd837b7e00e00de5684","5715ea6ac016190e00f04272","5715f27fc016190e00f0429f","5715f7b9893cbe0e002d74da","5715f8c2c016190e00f042b8","5715fd49a9055c0e0015fbe7","57160c7e893cbe0e002d753a","5716136a893cbe0e002d7552"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-19T12:08:12.067Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:html]\n{\n  \"html\": \"<h3>GetAlarms</h3>\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Columns</b></h4>\"\n}\n[/block]\nRefer to the following table for description of columns:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Nullability\",\n    \"h-4\": \"Note\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Unique identifier.\",\n    \"1-0\": \"`created`\",\n    \"1-1\": \"DateTime\",\n    \"1-2\": \"UTC\",\n    \"1-3\": \"FALSE\",\n    \"2-0\": \"`name`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"N/A\",\n    \"2-3\": \"FALSE\",\n    \"2-4\": \"Name of alarm.\",\n    \"3-0\": \"`type`\",\n    \"3-1\": \"String\",\n    \"3-2\": \"N/A\",\n    \"3-3\": \"FALSE\",\n    \"4-0\": \"`enabled`\",\n    \"4-1\": \"Bool\",\n    \"4-2\": \"N/A\",\n    \"4-3\": \"FALSE\",\n    \"5-0\": \"`allUnits`\",\n    \"5-1\": \"Bool\",\n    \"5-2\": \"N/A\",\n    \"5-3\": \"FALSE\",\n    \"6-0\": \"`units`\",\n    \"6-1\": \"String[]\",\n    \"6-2\": \"N/A\",\n    \"6-3\": \"TRUE\",\n    \"7-0\": \"`groups`\",\n    \"7-1\": \"String[]\",\n    \"7-2\": \"N/A\",\n    \"7-3\": \"TRUE\",\n    \"8-0\": \"`emailRecipients`\",\n    \"8-1\": \"String[]\",\n    \"8-2\": \"N/A\",\n    \"8-3\": \"TRUE\",\n    \"9-0\": \"`systemRecipients`\",\n    \"9-1\": \"String[]\",\n    \"9-2\": \"N/A\",\n    \"9-3\": \"TRUE\",\n    \"10-0\": \"`smsRecipients`\",\n    \"10-1\": \"String[]\",\n    \"10-2\": \"N/A\",\n    \"10-3\": \"TRUE\",\n    \"11-0\": \"`temperatureLimits`\",\n    \"11-1\": \"TemperatureAlarmLimits\",\n    \"11-2\": \"Celcius\",\n    \"11-3\": \"TRUE\",\n    \"12-0\": \"`ADVoltageLimits`\",\n    \"12-1\": \"ADVoltageAlarmLimits\",\n    \"12-2\": \"Volts\",\n    \"12-3\": \"TRUE\",\n    \"13-0\": \"`ADVoltageInputIndex`\",\n    \"13-1\": \"INT\",\n    \"13-2\": \"N/A\",\n    \"13-3\": \"TRUE\",\n    \"13-4\": \"(1,2,4)\",\n    \"14-0\": \"`threshold`\",\n    \"14-1\": \"Double\",\n    \"14-2\": \"N/A\",\n    \"14-3\": \"TRUE\",\n    \"15-0\": \"`batteryLevel`\",\n    \"15-1\": \"Double\",\n    \"15-2\": \"Percent of battery charge\",\n    \"15-3\": \"TRUE\",\n    \"15-4\": \"(0, 100)\",\n    \"16-1\": \"Double\",\n    \"16-0\": \"`radius`\",\n    \"16-2\": \"Kilometers\",\n    \"16-3\": \"TRUE\",\n    \"17-0\": \"`inputIndex`\",\n    \"17-1\": \"INT\",\n    \"17-2\": \"N/A\",\n    \"17-3\": \"TRUE\",\n    \"18-0\": \"`interval`\",\n    \"18-1\": \"Double\",\n    \"18-2\": \"Seconds\",\n    \"18-3\": \"TRUE\",\n    \"19-0\": \"`pointId`\",\n    \"19-1\": \"String\",\n    \"19-2\": \"N/A\",\n    \"19-3\": \"TRUE\",\n    \"20-0\": \"`expectedArrivalTime`\",\n    \"20-1\": \"DateTime\",\n    \"20-2\": \"UTC\",\n    \"20-3\": \"TRUE\",\n    \"21-0\": \"`powerLevel`\",\n    \"21-1\": \"Double\",\n    \"21-2\": \"Volts\",\n    \"21-3\": \"TRUE\",\n    \"22-0\": \"`weekdays`\",\n    \"22-1\": \"String[]\",\n    \"22-2\": \"N/A\",\n    \"22-3\": \"TRUE\",\n    \"23-0\": \"`timeStart`\",\n    \"23-1\": \"TimeOfDay\",\n    \"23-2\": \"Local\",\n    \"23-3\": \"TRUE\",\n    \"24-0\": \"`timeEnd`\",\n    \"24-1\": \"TimeOfDay\",\n    \"24-2\": \"Local\",\n    \"24-3\": \"TRUE\",\n    \"25-0\": \"`zoneId`\",\n    \"25-1\": \"String\",\n    \"25-2\": \"N/A\",\n    \"25-3\": \"TRUE\"\n  },\n  \"cols\": 5,\n  \"rows\": 26\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Request (example)</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Response</b></h4>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"list\\\": [\\n    {\\n      \\\"id\\\": \\\"70329\\\",\\n      \\\"created\\\": \\\"2014-03-03T13:51:15.7166931Z\\\",\\n      \\\"name\\\": \\\"Zone alarm, Pauliström\\\",\\n      \\\"type\\\": \\\"ByZoneEnter\\\",\\n      \\\"enabled\\\": true,\\n      \\\"allUnits\\\": true,\\n      \\\"units\\\": [],\\n      \\\"groups\\\": [],\\n      \\\"emailRecipients\\\": [\\n        \\\"29829\\\"\\n      ],\\n      \\\"systemRecipients\\\": [],\\n      \\\"smsRecipients\\\": [],\\n      \\\"zoneId\\\": \\\"6295\\\"\\n    },\\n    {\\n      \\\"id\\\": \\\"70356\\\",\\n      \\\"created\\\": \\\"2014-03-04T08:07:08.0332907Z\\\",\\n      \\\"name\\\": \\\"Low battery alarm\\\",\\n      \\\"type\\\": \\\"ByBatteryLevel\\\",\\n      \\\"enabled\\\": true,\\n      \\\"allUnits\\\": true,\\n      \\\"units\\\": [],\\n      \\\"groups\\\": [],\\n      \\\"emailRecipients\\\": [\\n        \\\"29830\\\"\\n      ],\\n      \\\"systemRecipients\\\": [],\\n      \\\"smsRecipients\\\": [],\\n      \\\"batteryLevel\\\": 30\\n    },\\n    {\\n      \\\"id\\\": \\\"70357\\\",\\n      \\\"created\\\": \\\"2014-03-04T08:41:08.6614280Z\\\",\\n      \\\"name\\\": \\\"Weekend alarm\\\",\\n      \\\"type\\\": \\\"ByWorkTime\\\",\\n      \\\"enabled\\\": true,\\n      \\\"allUnits\\\": false,\\n      \\\"units\\\": [],\\n      \\\"groups\\\": [\\n        \\\"8819\\\"\\n      ],\\n      \\\"emailRecipients\\\": [\\n        \\\"29831\\\"\\n      ],\\n      \\\"systemRecipients\\\": [],\\n      \\\"smsRecipients\\\": [],\\n      \\\"weekdays\\\": [\\n        \\\"Sunday\\\"\\n      ],\\n      \\\"timeStart\\\": {\\n        \\\"hour\\\": 0,\\n        \\\"minute\\\": 0\\n      },\\n      \\\"timeEnd\\\": {\\n        \\\"hour\\\": 23,\\n        \\\"minute\\\": 45\\n      }\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Will list all alarms.\n\nURL Structure is:\n`https://api.trackunit.com/public/Alarm`","slug":"alarms-collection","type":"basic","title":"Alarms Collection"}

Alarms Collection

Will list all alarms. URL Structure is: `https://api.trackunit.com/public/Alarm`

[block:html] { "html": "<h3>GetAlarms</h3>" } [/block] [block:html] { "html": "<h4><b>Columns</b></h4>" } [/block] Refer to the following table for description of columns: [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Nullability", "h-4": "Note", "0-0": "`id`", "0-1": "String", "0-2": "N/A", "0-3": "Unique identifier.", "1-0": "`created`", "1-1": "DateTime", "1-2": "UTC", "1-3": "FALSE", "2-0": "`name`", "2-1": "String", "2-2": "N/A", "2-3": "FALSE", "2-4": "Name of alarm.", "3-0": "`type`", "3-1": "String", "3-2": "N/A", "3-3": "FALSE", "4-0": "`enabled`", "4-1": "Bool", "4-2": "N/A", "4-3": "FALSE", "5-0": "`allUnits`", "5-1": "Bool", "5-2": "N/A", "5-3": "FALSE", "6-0": "`units`", "6-1": "String[]", "6-2": "N/A", "6-3": "TRUE", "7-0": "`groups`", "7-1": "String[]", "7-2": "N/A", "7-3": "TRUE", "8-0": "`emailRecipients`", "8-1": "String[]", "8-2": "N/A", "8-3": "TRUE", "9-0": "`systemRecipients`", "9-1": "String[]", "9-2": "N/A", "9-3": "TRUE", "10-0": "`smsRecipients`", "10-1": "String[]", "10-2": "N/A", "10-3": "TRUE", "11-0": "`temperatureLimits`", "11-1": "TemperatureAlarmLimits", "11-2": "Celcius", "11-3": "TRUE", "12-0": "`ADVoltageLimits`", "12-1": "ADVoltageAlarmLimits", "12-2": "Volts", "12-3": "TRUE", "13-0": "`ADVoltageInputIndex`", "13-1": "INT", "13-2": "N/A", "13-3": "TRUE", "13-4": "(1,2,4)", "14-0": "`threshold`", "14-1": "Double", "14-2": "N/A", "14-3": "TRUE", "15-0": "`batteryLevel`", "15-1": "Double", "15-2": "Percent of battery charge", "15-3": "TRUE", "15-4": "(0, 100)", "16-1": "Double", "16-0": "`radius`", "16-2": "Kilometers", "16-3": "TRUE", "17-0": "`inputIndex`", "17-1": "INT", "17-2": "N/A", "17-3": "TRUE", "18-0": "`interval`", "18-1": "Double", "18-2": "Seconds", "18-3": "TRUE", "19-0": "`pointId`", "19-1": "String", "19-2": "N/A", "19-3": "TRUE", "20-0": "`expectedArrivalTime`", "20-1": "DateTime", "20-2": "UTC", "20-3": "TRUE", "21-0": "`powerLevel`", "21-1": "Double", "21-2": "Volts", "21-3": "TRUE", "22-0": "`weekdays`", "22-1": "String[]", "22-2": "N/A", "22-3": "TRUE", "23-0": "`timeStart`", "23-1": "TimeOfDay", "23-2": "Local", "23-3": "TRUE", "24-0": "`timeEnd`", "24-1": "TimeOfDay", "24-2": "Local", "24-3": "TRUE", "25-0": "`zoneId`", "25-1": "String", "25-2": "N/A", "25-3": "TRUE" }, "cols": 5, "rows": 26 } [/block] [block:html] { "html": "<h4><b>Request (example)</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{}", "language": "json" } ] } [/block] [block:html] { "html": "<h4><b>Response</b></h4>" } [/block] [block:code] { "codes": [ { "code": "{\n \"list\": [\n {\n \"id\": \"70329\",\n \"created\": \"2014-03-03T13:51:15.7166931Z\",\n \"name\": \"Zone alarm, Pauliström\",\n \"type\": \"ByZoneEnter\",\n \"enabled\": true,\n \"allUnits\": true,\n \"units\": [],\n \"groups\": [],\n \"emailRecipients\": [\n \"29829\"\n ],\n \"systemRecipients\": [],\n \"smsRecipients\": [],\n \"zoneId\": \"6295\"\n },\n {\n \"id\": \"70356\",\n \"created\": \"2014-03-04T08:07:08.0332907Z\",\n \"name\": \"Low battery alarm\",\n \"type\": \"ByBatteryLevel\",\n \"enabled\": true,\n \"allUnits\": true,\n \"units\": [],\n \"groups\": [],\n \"emailRecipients\": [\n \"29830\"\n ],\n \"systemRecipients\": [],\n \"smsRecipients\": [],\n \"batteryLevel\": 30\n },\n {\n \"id\": \"70357\",\n \"created\": \"2014-03-04T08:41:08.6614280Z\",\n \"name\": \"Weekend alarm\",\n \"type\": \"ByWorkTime\",\n \"enabled\": true,\n \"allUnits\": false,\n \"units\": [],\n \"groups\": [\n \"8819\"\n ],\n \"emailRecipients\": [\n \"29831\"\n ],\n \"systemRecipients\": [],\n \"smsRecipients\": [],\n \"weekdays\": [\n \"Sunday\"\n ],\n \"timeStart\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"timeEnd\": {\n \"hour\": 23,\n \"minute\": 45\n }\n }\n ]\n}", "language": "json" } ] } [/block]