{"_id":"571620e8893cbe0e002d758b","__v":11,"githubsync":"","parentDoc":null,"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"},"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","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-19T12:13:28.545Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:html]\n{\n  \"html\": \"<h3>GetAlarmLog</h3>\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h4><b>Parameters</b></h4>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Unit of measurement\",\n    \"h-3\": \"Note\",\n    \"0-0\": \"`unitId`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"Unit identifier. If supplied, we return only logs for that alarm.\",\n    \"1-0\": \"`dateFrom`\",\n    \"1-1\": \"DateTime\",\n    \"1-2\": \"UTC\",\n    \"1-3\": \"If supplied, only logs for alarms triggered *after* this date will be returned.\",\n    \"2-0\": \"`dateTo`\",\n    \"2-1\": \"DateTime\",\n    \"2-2\": \"UTC\",\n    \"2-3\": \"If supplied, only logs for alarms triggered *before* this date will be returned.\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\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\": \"`alarmId`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"0-3\": \"FALSE\",\n    \"0-4\": \"Unit identifier.\",\n    \"1-0\": \"`unitId`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"FALSE\",\n    \"1-4\": \"Unit identifier.\",\n    \"2-0\": \"`triggeredAt`\",\n    \"2-1\": \"DateTime\",\n    \"2-2\": \"UTC\",\n    \"2-3\": \"FALSE\",\n    \"3-0\": \"`address`\",\n    \"3-1\": \"Address\",\n    \"3-2\": \"N/A\",\n    \"3-3\": \"FALSE\",\n    \"4-0\": \"`location`\",\n    \"4-1\": \"Location\",\n    \"4-2\": \"N/A\",\n    \"4-3\": \"FALSE\",\n    \"5-0\": \"`recipients`\",\n    \"5-1\": \"AlarmRecipient\",\n    \"5-2\": \"N/A\",\n    \"5-3\": \"FALSE\"\n  },\n  \"cols\": 5,\n  \"rows\": 6\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      \\\"alarmId\\\": \\\"70329\\\",\\n      \\\"unitId\\\": \\\"34333\\\",\\n      \\\"triggeredAt\\\": \\\"2014-03-05T07:00:02.7421152Z\\\",\\n      \\\"address\\\": {\\n        \\\"country\\\": \\\"DK\\\",\\n        \\\"zipCode\\\": \\\"3120\\\",\\n        \\\"city\\\": \\\"Dronningmølle\\\",\\n        \\\"streetAddress\\\": \\\"Dr Mølle Strandvej 556\\\"\\n      },\\n      \\\"location\\\": {\\n        \\\"latitude\\\": 56.5802783333333,\\n        \\\"longitude\\\": 8.5522\\n      },\\n      \\\"recipients\\\": [\\n        {\\n          \\\"contactId\\\": 29829,\\n          \\\"sentVia\\\": \\\"Mail\\\",\\n          \\\"phoneNumber\\\": \\\"499988776655\\\",\\n          \\\"email\\\": \\\"ewm:::at:::chemnitzbau.com\\\",\\n          \\\"delivered\\\": true\\n        }\\n      ]\\n    },\\n    {\\n      \\\"alarmId\\\": \\\"70329\\\",\\n      \\\"unitId\\\": \\\"39670\\\",\\n      \\\"triggeredAt\\\": \\\"2014-03-05T07:00:02.7421152Z\\\",\\n      \\\"address\\\": {\\n        \\\"country\\\": \\\"DK\\\",\\n        \\\"zipCode\\\": \\\"3520\\\",\\n        \\\"city\\\": \\\"Farum\\\",\\n        \\\"streetAddress\\\": \\\"Farum Gydevej 73\\\"\\n      },\\n      \\\"location\\\": {\\n        \\\"latitude\\\": 56.0230783333333,\\n        \\\"longitude\\\": 8.38722\\n      },\\n      \\\"recipients\\\": [\\n        {\\n          \\\"contactId\\\": 29829,\\n          \\\"sentVia\\\": \\\"Mail\\\",\\n          \\\"phoneNumber\\\": \\\"499988776655\\\",\\n          \\\"email\\\": \\\"ewm@chemnitzbau.com\\\",\\n          \\\"delivered\\\": true\\n        }\\n      ]\\n    },\\n    {\\n      \\\"alarmId\\\": \\\"70329\\\",\\n      \\\"unitId\\\": \\\"46208\\\",\\n      \\\"triggeredAt\\\": \\\"2014-03-05T07:00:02.7421152Z\\\",\\n      \\\"address\\\": {\\n        \\\"country\\\": \\\"DK\\\",\\n        \\\"zipCode\\\": \\\"2660\\\",\\n        \\\"city\\\": \\\"Brøndby Strand\\\",\\n        \\\"streetAddress\\\": \\\"Dyringparken 132\\\"\\n      },\\n      \\\"location\\\": {\\n        \\\"latitude\\\": 56.5546116666667,\\n        \\\"longitude\\\": 8.55791333333333\\n      },\\n      \\\"recipients\\\": [\\n        {\\n          \\\"contactId\\\": 29829,\\n          \\\"sentVia\\\": \\\"Mail\\\",\\n          \\\"phoneNumber\\\": \\\"499988776655\\\",\\n          \\\"email\\\": \\\"ewm@chemnitzbau.com\\\",\\n          \\\"delivered\\\": true\\n        }\\n      ]\\n    },\\n    {\\n      \\\"alarmId\\\": \\\"70329\\\",\\n      \\\"unitId\\\": \\\"46209\\\",\\n      \\\"triggeredAt\\\": \\\"2014-03-05T07:00:02.7421152Z\\\",\\n      \\\"address\\\": {\\n        \\\"country\\\": \\\"DK\\\",\\n        \\\"zipCode\\\": \\\"3050\\\",\\n        \\\"city\\\": \\\"Humlebæk\\\",\\n        \\\"streetAddress\\\": \\\"Kirkeskov Alle 13\\\"\\n      },\\n      \\\"location\\\": {\\n        \\\"latitude\\\": 55.6207083333333,\\n        \\\"longitude\\\": 12.3338833333333\\n      },\\n      \\\"recipients\\\": [\\n        {\\n          \\\"contactId\\\": 29829,\\n          \\\"sentVia\\\": \\\"Mail\\\",\\n          \\\"phoneNumber\\\": \\\"499988776655\\\",\\n          \\\"email\\\": \\\"ewm@chemnitzbau.com\\\",\\n          \\\"delivered\\\": true\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Will list all historically triggered alarms.\n\nURL Structure is:\n`https://api.trackunit.com/public/AlarmLog`","slug":"alarm-log","type":"basic","title":"Alarm Log"}

Alarm Log

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

[block:html] { "html": "<h3>GetAlarmLog</h3>" } [/block] [block:html] { "html": "<h4><b>Parameters</b></h4>" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Unit of measurement", "h-3": "Note", "0-0": "`unitId`", "0-1": "String", "0-2": "N/A", "0-3": "Unit identifier. If supplied, we return only logs for that alarm.", "1-0": "`dateFrom`", "1-1": "DateTime", "1-2": "UTC", "1-3": "If supplied, only logs for alarms triggered *after* this date will be returned.", "2-0": "`dateTo`", "2-1": "DateTime", "2-2": "UTC", "2-3": "If supplied, only logs for alarms triggered *before* this date will be returned." }, "cols": 4, "rows": 3 } [/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": "`alarmId`", "0-1": "String", "0-2": "N/A", "0-3": "FALSE", "0-4": "Unit identifier.", "1-0": "`unitId`", "1-1": "String", "1-2": "N/A", "1-3": "FALSE", "1-4": "Unit identifier.", "2-0": "`triggeredAt`", "2-1": "DateTime", "2-2": "UTC", "2-3": "FALSE", "3-0": "`address`", "3-1": "Address", "3-2": "N/A", "3-3": "FALSE", "4-0": "`location`", "4-1": "Location", "4-2": "N/A", "4-3": "FALSE", "5-0": "`recipients`", "5-1": "AlarmRecipient", "5-2": "N/A", "5-3": "FALSE" }, "cols": 5, "rows": 6 } [/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 \"alarmId\": \"70329\",\n \"unitId\": \"34333\",\n \"triggeredAt\": \"2014-03-05T07:00:02.7421152Z\",\n \"address\": {\n \"country\": \"DK\",\n \"zipCode\": \"3120\",\n \"city\": \"Dronningmølle\",\n \"streetAddress\": \"Dr Mølle Strandvej 556\"\n },\n \"location\": {\n \"latitude\": 56.5802783333333,\n \"longitude\": 8.5522\n },\n \"recipients\": [\n {\n \"contactId\": 29829,\n \"sentVia\": \"Mail\",\n \"phoneNumber\": \"499988776655\",\n \"email\": \"ewm@chemnitzbau.com\",\n \"delivered\": true\n }\n ]\n },\n {\n \"alarmId\": \"70329\",\n \"unitId\": \"39670\",\n \"triggeredAt\": \"2014-03-05T07:00:02.7421152Z\",\n \"address\": {\n \"country\": \"DK\",\n \"zipCode\": \"3520\",\n \"city\": \"Farum\",\n \"streetAddress\": \"Farum Gydevej 73\"\n },\n \"location\": {\n \"latitude\": 56.0230783333333,\n \"longitude\": 8.38722\n },\n \"recipients\": [\n {\n \"contactId\": 29829,\n \"sentVia\": \"Mail\",\n \"phoneNumber\": \"499988776655\",\n \"email\": \"ewm@chemnitzbau.com\",\n \"delivered\": true\n }\n ]\n },\n {\n \"alarmId\": \"70329\",\n \"unitId\": \"46208\",\n \"triggeredAt\": \"2014-03-05T07:00:02.7421152Z\",\n \"address\": {\n \"country\": \"DK\",\n \"zipCode\": \"2660\",\n \"city\": \"Brøndby Strand\",\n \"streetAddress\": \"Dyringparken 132\"\n },\n \"location\": {\n \"latitude\": 56.5546116666667,\n \"longitude\": 8.55791333333333\n },\n \"recipients\": [\n {\n \"contactId\": 29829,\n \"sentVia\": \"Mail\",\n \"phoneNumber\": \"499988776655\",\n \"email\": \"ewm@chemnitzbau.com\",\n \"delivered\": true\n }\n ]\n },\n {\n \"alarmId\": \"70329\",\n \"unitId\": \"46209\",\n \"triggeredAt\": \"2014-03-05T07:00:02.7421152Z\",\n \"address\": {\n \"country\": \"DK\",\n \"zipCode\": \"3050\",\n \"city\": \"Humlebæk\",\n \"streetAddress\": \"Kirkeskov Alle 13\"\n },\n \"location\": {\n \"latitude\": 55.6207083333333,\n \"longitude\": 12.3338833333333\n },\n \"recipients\": [\n {\n \"contactId\": 29829,\n \"sentVia\": \"Mail\",\n \"phoneNumber\": \"499988776655\",\n \"email\": \"ewm@chemnitzbau.com\",\n \"delivered\": true\n }\n ]\n }\n ]\n}", "language": "json" } ] } [/block]