{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/maintenance/view.json","auth":"required","results":{"codes":[{"name":"","code":"{ \n \"result\":{ \n \"alertId\":\"b30203c1-6b87-11e7-b7d1-cdb9264a1bcd\",\n \"customerId\":4356,\n \"alertType\":{ \n \"alertTypeId\":11,\n \"name\":\"Scheduled Maintenance\"\n },\n \"cc\":null,\n \"mode\":1,\n \"alertName\":\"Brian Vehicle Alert\",\n \"users\":[ \n { \n \"alertToUserIdMappingForMailId\":\"b3022acb-6b87-11e7-8af2-c9975b415928\",\n \"userId\":\"4e6f7215-6a3b-11e6-bcfa-131080f6fd8e\"\n }\n ],\n \"ruleSets\":[ \n { \n \"ruleSetId\":\"2a6782c6-6c66-11e7-be8b-35e277d235ec\",\n \"name\":\"Brake Inspection\",\n \"ruleConditions\":[ \n { \n \"ruleConditionId\":\"2a67a9d0-6c66-11e7-91ac-1dc1765c1c41\",\n \"baseValue\":\"0\",\n \"requiredValue\":\"65.00002192795111\",\n \"conditionType\":0,\n \"reminderFired\":false,\n \"alertFired\":false\n },\n { \n \"ruleConditionId\":\"2a67a9d0-6c66-11e7-91ac-bb5b356cdc0a\",\n \"baseValue\":\"2017-07-19 04:00:00.0\",\n \"requiredValue\":\"1\",\n \"conditionType\":1,\n \"reminderFired\":false,\n \"alertFired\":false\n },\n { \n \"ruleConditionId\":\"2a67a9d0-6c66-11e7-91ac-db3581af0c03\",\n \"baseValue\":\"0\",\n \"requiredValue\":\"2\",\n \"conditionType\":2,\n \"reminderFired\":false,\n \"alertFired\":false\n }\n ],\n \"vehicleId\":\"65e41296-63f2-11e6-b90f-bd1efd399b4f\",\n \"vehicleName\":\"Brian\",\n \"alertId\":\"b30203c1-6b87-11e7-b7d1-cdb9264a1bcd\",\n \"alertName\":\"Brian Vehicle Alert\",\n \"milesDriven\":16261,\n \"engineRunTime\":1145953\n }\n ],\n \"alertReminders\":[ \n { \n \"alertReminderId\":\"b30203c1-6b87-11e7-b7d1-cfdc84ec1908\",\n \"days\":1,\n \"miles\":19.883878707885742,\n \"engineHours\":1\n }\n ]\n }\n}","language":"json","status":200}]},"settings":"559288b86bf22f170075b794","params":[{"name":"alertName","type":"string","default":"","desc":"Name of the alert","required":true,"in":"query","ref":"","_id":"598983d2a152dd001bc0bebc"}],"examples":{"codes":[]},"method":"post"},"next":{"description":"","pages":[]},"title":"View","type":"endpoint","slug":"view-2","excerpt":"Use this API to get the details of a specific maintenance alert. You need to pass the name of the alert while calling this API.","body":"[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Sample Request\",\n \"body\": \"https://api.azuga.com/azuga-ws/v1/maintenance/view.json\"\n}\n[/block]\n##API Response Explanation \n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field\",\n \"h-1\": \"Description\",\n \"0-0\": \"alertId\",\n \"1-0\": \"customerId\",\n \"2-0\": \"alertTypeId\",\n \"3-0\": \"name\",\n \"4-0\": \"cc\",\n \"5-0\": \"mode\",\n \"0-1\": \"Unique identifier representing the alert\",\n \"1-1\": \"Unique identifier representing the customer’s account\",\n \"2-1\": \"Unique identifier representing the alert type\",\n \"3-1\": \"Type of alert\",\n \"4-1\": \"CC addresses to which the alert emails are sent\",\n \"5-1\": \"Mode of sending the alert emails. There are two modes:\\n\\n1 - Instant, the email will be sent as soon as the vehicle crosses the alert threshold set\\n2 - Hourly, a summary of alert emails will be sent once per hour\",\n \"6-0\": \"alertName\",\n \"6-1\": \"Name of the alert\",\n \"7-0\": \"alertToUserIdMappingForMailId\",\n \"7-1\": \"Unique identifier representing the user to email mapping\",\n \"8-0\": \"userId\",\n \"8-1\": \"Unique identifier representing the user to whom the alert emails are sent\",\n \"9-0\": \"ruleSetId\",\n \"9-1\": \"Unique identifier representing the rule set\",\n \"10-0\": \"name\",\n \"10-1\": \"Name of the rule set\",\n \"11-0\": \"ruleConditionId\",\n \"11-1\": \"Unique identifier representing the rule condition. For each rule set, there are 3 rule conditions (mileage, time interval, and engine run time)\",\n \"12-0\": \"baseValue\",\n \"12-1\": \"Default value used for triggering the alert\",\n \"13-0\": \"requiredValue\",\n \"13-1\": \"Value set by you for triggering the alert\",\n \"14-0\": \"conditionType\",\n \"14-1\": \"Types of alert conditions \\n\\n0 - Mileage \\n1 - Time Interval\\n2 - Engine Run Time\",\n \"15-0\": \"reminderFired\",\n \"15-1\": \"Boolean indicating if the reminder email triggered\",\n \"16-0\": \"alertFired\",\n \"16-1\": \"Boolean indicating if the alert triggered\",\n \"17-0\": \"vehicleId\",\n \"17-1\": \"Unique identifier representing the vehicle for which the alert is applied\",\n \"18-0\": \"vehicleName\",\n \"18-1\": \"Name of the vehicle\",\n \"19-0\": \"alertId\",\n \"19-1\": \"Unique identifier representing the alert\",\n \"20-0\": \"alertName\",\n \"20-1\": \"Name of the alert\",\n \"21-0\": \"milesDriven\",\n \"21-1\": \"Current mileage of the vehicle\",\n \"22-0\": \"engineRunTime\",\n \"22-1\": \"Current engine run time in Hours\",\n \"23-0\": \"alertReminderId\",\n \"23-1\": \"Unique identifier representing the reminder alert\",\n \"24-0\": \"days\",\n \"24-1\": \"Number of days before the actual threshold, the reminder email is to be sent\",\n \"25-0\": \"miles\",\n \"25-1\": \"Number of miles before the actual threshold, the reminder email is to be sent\",\n \"26-0\": \"engineHours\",\n \"26-1\": \"Number of engine hours before the actual threshold, the reminder email is to be sent\"\n },\n \"cols\": 2,\n \"rows\": 27\n}\n[/block]","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59895fed9332d300190f48af","project":"55926c913735880d005f7c65","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["559286c7c39c4b2d00127a72","55928a98c39c4b2d00127a83","5592bd7b9a68220d00f1c3db","5593dcaf0e82e81700334e25","5594342f0c33bd0d000595a3","563081713998420d00a509e4","5630941c7581b80d00c51c86","56309f4ff1c0580d00fac666","567923b8239fac0d00c7df25","573306dea6a9c40e00e13875","577a288fd051530e00f65563","579af3982b865e17005a4357","57ee06aa1e42900e0014a374","5951f49a63f39000159e7ef1","5951f4c563f39000159e7ef2","598951542a9dfc000fcacd40","5b3375cc98cb500003e4b363","5bbcd4e29667280003084100"],"_id":"559286c6c39c4b2d00127a71","createdAt":"2015-06-30T12:08:38.768Z","project":"55926c913735880d005f7c65","releaseDate":"2015-06-30T12:08:38.768Z","__v":18,"forked_from":"559286b6c39c4b2d00127a6e"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"MAINTENANCE","slug":"maintenance","order":9999,"from_sync":false,"reference":false,"_id":"598951542a9dfc000fcacd40","project":"55926c913735880d005f7c65","version":"559286c6c39c4b2d00127a71","createdAt":"2017-08-08T05:51:16.345Z","__v":0},"user":"5656a3dd5656350d001d83a0","createdAt":"2017-08-08T06:53:33.893Z","githubsync":"","__v":2,"parentDoc":null}
postView
Use this API to get the details of a specific maintenance alert. You need to pass the name of the alert while calling this API.
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Query Params
alertName:
required
string
Name of the alert