{"_id":"571613865d90dc170060edfc","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"},"parentDoc":null,"user":"56d548ba075dfa0b00be98d2","githubsync":"","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"},"__v":43,"project":"56d54a77075dfa0b00be98d5","updates":["5d28715f0d590703db3c973c"],"next":{"pages":[],"description":""},"createdAt":"2016-04-19T11:16:22.775Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:html]\n{\n  \"html\": \"<h3>General alarm types</h3>\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Alarm\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"Geofence\\n`ByCustomPoint`\",\n    \"0-1\": \"Geofence alarm.\",\n    \"1-0\": \"Alarm by Zone\\n`ByZoneEnter`\",\n    \"1-1\": \"When entering zone.\",\n    \"2-0\": \"Alarm by Zone\\n`ByZoneLeave`\",\n    \"2-1\": \"When leaving zone.\",\n    \"3-0\": \"Alarm by Zone\\n`ByZoneArrival`\",\n    \"3-1\": \"Not entered zone before given time.\",\n    \"4-0\": \"Alarm by Movement\\n`ByWorkTime`\",\n    \"4-1\": \"If movement is registered within timeframe.\",\n    \"5-0\": \"Alarm by Temperature\\n`ByTemperature`\",\n    \"5-1\": \"If upper or lower temperature level is exceeded. The alarm can only be triggered by units with temperature sensor.\",\n    \"6-0\": \"Alarm by Point\\n`ByPointEnter`\",\n    \"6-1\": \"When approaching point.\",\n    \"7-0\": \"Alarm by Point\\n`ByPointLeave`\",\n    \"7-1\": \"When moving away from point.\",\n    \"8-0\": \"Alarm by Point\\n`ByPointArrival`\",\n    \"8-1\": \"Not approached point before given time.\",\n    \"9-0\": \"Alarm by Input\\n`ByInput`\",\n    \"9-1\": \"When activity is registered on input 1-4.\",\n    \"10-0\": \"Alarm by Unit state\\n`ByPowerLevel`\",\n    \"10-1\": \"Power level less than (V).\",\n    \"11-0\": \"Alarm by Unit state\\n`ByBatteryLevel`\",\n    \"11-1\": \"Internal battery level less than (%).\",\n    \"12-0\": \"Alarm by Unit state\\n`ByNoGpsFix`\",\n    \"12-1\": \"No GPS fix within x hours.\",\n    \"13-0\": \"Alarm by Unit state\\n`ByNoData`\",\n    \"13-1\": \"No transmission of data within x hours.\",\n    \"14-0\": \"Alarm by Unit state\\n`ByAcceleration`\",\n    \"14-1\": \"If unit accelerates heavily.\",\n    \"15-0\": \"Alarm by Input voltage\\n`ByADVoltage`\",\n    \"15-1\": \"If upper or lower voltage level is exceeded, on input 1,2 or 4. The alarm can only be triggered by units transmitting voltage levels.\"\n  },\n  \"cols\": 2,\n  \"rows\": 16\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>GetAlarm</h3>\"\n}\n[/block]\nWill list parameters on a specified alarm.\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\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\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   \\\"id\\\": \\\"70356\\\"\\n}\",\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\\\": \\\"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}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>CreateAlarm</h3>\"\n}\n[/block]\nWill create a new alarm.\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    \"0-0\": \"`name` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"1-0\": \"`type` <span style=\\\"color:red\\\">*</span>\",\n    \"1-1\": \"String\\n*(see list of alarm types)*\",\n    \"1-2\": \"N/A\",\n    \"2-0\": \"`enabled`\",\n    \"2-1\": \"Bool\",\n    \"2-2\": \"N/A\",\n    \"3-2\": \"N/A\",\n    \"4-2\": \"N/A\",\n    \"5-2\": \"N/A\",\n    \"6-2\": \"N/A\",\n    \"7-2\": \"N/A\",\n    \"3-0\": \"`allUnits`\",\n    \"3-1\": \"Bool\",\n    \"4-0\": \"`units`\",\n    \"4-1\": \"String[]\",\n    \"5-0\": \"`groups`\",\n    \"5-1\": \"String[]\",\n    \"6-0\": \"`emailRecipients`\",\n    \"6-1\": \"String[]\",\n    \"7-0\": \"`systemRecipients`\",\n    \"7-1\": \"String[]\",\n    \"8-0\": \"`smsRecipients`\",\n    \"8-1\": \"String[]\",\n    \"9-0\": \"`temperatureLimits`\",\n    \"9-1\": \"TemperatureAlarmLimits\",\n    \"9-2\": \"Celcius\",\n    \"8-2\": \"N/A\",\n    \"10-0\": \"`ADVoltageLimits`\",\n    \"10-1\": \"ADVoltageAlarmLimits\",\n    \"10-2\": \"Volts\",\n    \"11-0\": \"`ADVoltageInputIndex`\",\n    \"11-1\": \"INT\",\n    \"11-2\": \"N/A\",\n    \"12-0\": \"`threshold`\",\n    \"12-1\": \"Double\",\n    \"12-2\": \"N/A\",\n    \"13-0\": \"`batteryLevel`\",\n    \"13-1\": \"Double\",\n    \"13-2\": \"Percent of battery charge\",\n    \"14-0\": \"`location`\",\n    \"14-1\": \"Location\",\n    \"14-2\": \"N/A\",\n    \"15-0\": \"`radius`\",\n    \"15-1\": \"Double\",\n    \"15-2\": \"Kilometers\",\n    \"16-0\": \"`inputIndex`\",\n    \"16-1\": \"INT\",\n    \"16-2\": \"N/A\",\n    \"17-0\": \"`interval`\",\n    \"17-1\": \"Double\",\n    \"17-2\": \"Seconds\",\n    \"18-0\": \"`pointId`\",\n    \"18-1\": \"String\",\n    \"18-2\": \"N/A\",\n    \"19-0\": \"`expectedArrivalTime`\",\n    \"19-1\": \"DateTime\",\n    \"19-2\": \"UTC\",\n    \"20-0\": \"`powerLevel`\",\n    \"20-1\": \"Double\",\n    \"20-2\": \"Volts\",\n    \"21-0\": \"`weekdays`\",\n    \"21-1\": \"String[]\",\n    \"21-2\": \"N/A\",\n    \"22-0\": \"`timeStart`\",\n    \"22-1\": \"TimeOfDay\",\n    \"22-2\": \"Local\",\n    \"23-0\": \"`timeEnd`\",\n    \"23-1\": \"TimeOfDay\",\n    \"23-2\": \"Local\",\n    \"24-0\": \"`zoneId`\",\n    \"24-1\": \"Double\",\n    \"24-2\": \"N/A\"\n  },\n  \"cols\": 3,\n  \"rows\": 25\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  \\\"name\\\": \\\"Weekend alarm\\\",\\n  \\\"type\\\": \\\"ByWorkTime\\\",\\n  \\\"enabled\\\": true,\\n  \\\"allUnits\\\": true,\\n  \\\"emailRecipients\\\": [\\n    \\\"29831\\\"\\n  ],\\n  \\\"weekdays\\\": [\\n    \\\"Saturday\\\"\\n  ],\\n  \\\"timeStart\\\": {\\n    \\\"hour\\\": 0,\\n    \\\"minute\\\": 0\\n  },\\n  \\\"timeEnd\\\": {\\n    \\\"hour\\\": 23,\\n    \\\"minute\\\": 45\\n  }\\n}\",\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   \\\"id\\\": \\\"70367\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>UpdateAlarm</h3>\"\n}\n[/block]\nWill update parameters on an existing alarm.\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    \"0-3\": \"Name of alarm.\",\n    \"h-3\": \"Note\",\n    \"0-0\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"N/A\",\n    \"1-3\": \"Name of alarm.\",\n    \"2-0\": \"`type`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"N/A\",\n    \"2-3\": \"Type of alarm.\\n*(see list of alarm types)*\",\n    \"3-0\": \"`enabled`\",\n    \"3-1\": \"Bool\",\n    \"3-2\": \"N/A\",\n    \"4-0\": \"`allUnits`\",\n    \"4-1\": \"Bool\",\n    \"4-2\": \"N/A\",\n    \"5-0\": \"`units`\",\n    \"5-1\": \"String[]\",\n    \"5-2\": \"N/A\",\n    \"6-0\": \"`groups`\",\n    \"6-1\": \"String[]\",\n    \"6-2\": \"N/A\",\n    \"7-0\": \"`emailRecipients`\",\n    \"7-1\": \"String[]\",\n    \"7-2\": \"N/A\",\n    \"8-0\": \"`systemRecipients`\",\n    \"8-1\": \"String[]\",\n    \"8-2\": \"N/A\",\n    \"9-0\": \"`smsRecipients`\",\n    \"9-1\": \"String[]\",\n    \"9-2\": \"N/A\",\n    \"10-0\": \"`temperatureLimits`\",\n    \"10-1\": \"TemperatureAlarmLimits\",\n    \"10-2\": \"Celcius\",\n    \"11-0\": \"`ADVoltageLimits`\",\n    \"11-1\": \"ADVoltageAlarmLimits\",\n    \"11-2\": \"Volts\",\n    \"12-0\": \"`ADVoltageInputIndex`\",\n    \"12-1\": \"INT\",\n    \"12-2\": \"N/A\",\n    \"13-0\": \"`threshold`\",\n    \"13-1\": \"Double\",\n    \"13-2\": \"N/A\",\n    \"14-0\": \"`batteryLevel`\",\n    \"14-1\": \"Double\",\n    \"14-2\": \"Percent of battery charge\",\n    \"15-0\": \"`location`\",\n    \"15-1\": \"Location\",\n    \"15-2\": \"N/A\",\n    \"16-0\": \"`radius`\",\n    \"16-1\": \"Double\",\n    \"16-2\": \"Kilometers\",\n    \"17-0\": \"`inputIndex`\",\n    \"17-1\": \"INT\",\n    \"17-2\": \"N/A\",\n    \"18-0\": \"`interval`\",\n    \"18-1\": \"Double\",\n    \"18-2\": \"Seconds\",\n    \"19-0\": \"`pointId`\",\n    \"19-1\": \"String\",\n    \"19-2\": \"N/A\",\n    \"20-0\": \"`expectedArrivalTime`\",\n    \"20-1\": \"DateTime\",\n    \"20-2\": \"UTC\",\n    \"21-0\": \"`powerLevel`\",\n    \"21-1\": \"Double\",\n    \"21-2\": \"Volts\",\n    \"22-0\": \"`weekdays`\",\n    \"22-1\": \"String[]\",\n    \"22-2\": \"N/A\",\n    \"23-0\": \"`timeStart`\",\n    \"23-1\": \"TimeOfDay\",\n    \"23-2\": \"Local\",\n    \"24-0\": \"`timeEnd`\",\n    \"24-1\": \"TimeOfDay\",\n    \"24-2\": \"Local\",\n    \"25-0\": \"`zoneId`\",\n    \"25-1\": \"Double\",\n    \"25-2\": \"N/A\"\n  },\n  \"cols\": 4,\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  \\\"id\\\": \\\"70356\\\",\\n  \\\"name\\\": \\\"Battery less than 40 percent!\\\",\\n  \\\"allUnits\\\": false,\\n  \\\"addGroups\\\": [\\n    \\\"8819\\\"\\n  ],\\n  \\\"batteryLevel\\\": 40\\n}\",\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      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"&nbsp;\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h3>DeleteAlarm</h3>\"\n}\n[/block]\nWill delete an existing alarm.\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\": \"`id` <span style=\\\"color:red\\\">*</span>\",\n    \"0-1\": \"String\",\n    \"0-2\": \"N/A\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\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    \\\"id\\\": \\\"70356\\\"\\n}\",\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      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"An **Alarm** is essentially a mechanism that monitors the occurence of specific types of activity. If a unit for example is moved outside of a zone, or perhaps is being used on weekends, an alarm can be triggered.\n\nThere are different types of alarms to use with the different types of activity.\nAlarms can be sent via e-mail or SMS.\n\nURL Structure is:\n`https://api.trackunit.com/public/Alarm`","slug":"alarm","type":"basic","title":"Alarm"}