{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/diagnostics.json","auth":"required","examples":{"codes":[]},"method":"post","params":[{"name":"vehicleIds","type":"array_string","default":"","desc":"Unique identifier of the vehicle. Accepts multiple vehicle IDs separated by commas. One of the following is mandatory- vehicleIds, vehicleNames,groupIds, groupNames","required":false,"in":"body","ref":"","_id":"5797483e559b402b0044e602"},{"name":"vehicleNames","type":"array_string","default":"","desc":"Name of the vehicle. Accepts multiple names separated by commas","required":false,"in":"body","ref":"","_id":"5797483e559b402b0044e601"},{"name":"groupIds","type":"array_string","default":"","desc":"Unique identifier of the group. Accepts multiple group IDs separated by commas","required":false,"in":"body","ref":"","_id":"5797483e559b402b0044e600"},{"name":"groupNames","type":"array_string","default":"","desc":"Name of the vehicle’s group. Accepts multiple group names separated by commas","required":false,"in":"body","ref":"","_id":"5797483e559b402b0044e5ff"},{"name":"fromDate","type":"string","default":"","desc":"Include vehicle diagnostics for an interval starting from this timestamp. Timestamp should be in milliseconds or yyyy-mm-dd hh:mm:ss format","required":true,"in":"body","ref":"","_id":"5797483e559b402b0044e5fe"},{"name":"toDate","type":"string","default":"","desc":"Include vehicle diagnostics for an interval up to this timestamp. Timestamp should be in milliseconds or yyyy-mm-dd hh:mm:ss format","required":true,"in":"body","ref":"","_id":"5797483e559b402b0044e5fd"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"code\":200,\n   \"message\":\"Success\",\n   \"reason\":null,\n   \"generatedAt\":\"Jun-29-2016, 12:21 PM IST\",\n   \"result\":[  \n      {  \n         \"dtcMessageId\":\"1830283c-3772-11e6-8186-74e6e21fcfd2\",\n         \"vehicle\":\"Katie Office Car- 12\",\n         \"vehicleId\":\"ee02acb8-ac3e-11e4-90dd-e1190100e6eb\",\n         \"Address\":\"88 Santa Clara California USA\",\n         \"dateTime\":1466361051000,\n         \"code\":\"P2222\",\n         \"deviceId\":\"a3ee7b4d-f016-11e5-8786-c7f58ca0d030\",\n         \"description\":\"Oxides Of Nitrogen Sensor Heater Sense Circuit Range / Performance Bank 2\",\n         \"assetno\":102,\n         \"firstName\":\"Katie\",\n         \"lastName\":\"Wheeler\",\n         \"parentGroup\":\"Unit A\",\n         \"lat\":37.352485,\n         \"lng\":-121.955582,\n         \"foreParentGroup\":\"Default Group\",\n         \"offset\":420,\n         \"displayTimeZone\":\"Pacific\",\n         \"group\":\"Dispatch - C\",\n         \"repairImportance\":\"High\",\n         \"severityLevel\":\"High\",\n         \"detailedDescription\":\"\",\n         \"symptoms\":[  \n            \"Engine Light ON (or Service Engine Soon Warning Light)\"\n         ],\n         \"possibleCauses\":[  \n\n         ],\n         \"customerId\":1059\n      },\n      {  \n         \"dtcMessageId\":\"2f83fef8-3391-11e6-8186-74e6e21fcfd2\",\n         \"vehicle\":\"Adam’s Truck\",\n         \"vehicleId\":\"b0debf38-a8dd-e511-b684-616a28550141\",\n         \"Address\":\"145 Lakeshore Circle San Jose California\",\n         \"dateTime\":1466361051000,\n         \"code\":\"P0128\",\n         \"deviceId\":\"b3ce8b4d-f046-14e5-9086-d0h68ca0d780\",\n         \"description\":\"Coolant Thermostat (Coolant Temperature Below Thermostat  Regulating Temperature)\",\n         \"assetno\":10,\n         \"firstName\":\"Adam\",\n         \"lastName\":\"Tanner\",\n         \"parentGroup\":\"USA - Group 1\",\n         \"lat\":37.385579,\n         \"lng\":-121.894104,\n         \"foreParentGroup\":\"California - Group 5\",\n         \"offset\":420,\n         \"displayTimeZone\":\"Pacific\",\n         \"group\":\"West Coast\",\n         \"repairImportance\":\"High\",\n         \"severityLevel\":\"High\",\n         \"detailedDescription\":\"\",\n         \"symptoms\":[  \n\n         ],\n         \"possibleCauses\":[  \n\n         ],\n         \"customerId\":1059\n      }\n   ]\n}","name":""}]},"settings":"559288b86bf22f170075b794"},"next":{"description":"","pages":[]},"title":"Vehicle Diagnostics","type":"endpoint","slug":"vehicle-diagnostics","excerpt":"The Diagnostic API allows you to retrieve diagnostic information and DTCs (Diagnostic Trouble Code) reported by the OBD system of your vehicle. A DTC is an alphanumeric code used to identify vehicle problems.  For example, the DTC C1446 indicates a brake switch circuit failure. \n\nThe API response contains information such as the diagnostic code, definition of the code, vehicle name, location, and timestamp. \n\nDiagnostic information of multiple vehicles can be obtained in a single API call.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sample Request\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/diagnostics.json\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"vehicleIds\\\":[  \\n      \\\"ad965910-3685-11e5-b8e2-c5b6a804c369\\\",\\n      \\\"cc24608d-dc14-11e4-bf2b-435f55649c28\\\"\\n    ],\\n   \\\"fromDate\\\":\\\"2016-06-20 00:00:00\\\",\\n   \\\"toDate\\\":\\\"2016-06-21 23:59:00\\\"\\n}\\n\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n##API Response explanation\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"code\",\n    \"0-1\": \"API Status Code\",\n    \"1-0\": \"message\",\n    \"2-0\": \"reason\",\n    \"3-0\": \"generatedAt\",\n    \"4-0\": \"dtcMessageId\",\n    \"1-1\": \"API Message (Success/Failure)\",\n    \"2-1\": \"Reason for failure\",\n    \"3-1\": \"API generation timestamp in UTC\",\n    \"4-1\": \"Message ID (internal reference)\",\n    \"5-0\": \"vehicle\",\n    \"6-0\": \"address\",\n    \"7-0\": \"DateTime\",\n    \"8-0\": \"code\",\n    \"5-1\": \"Name of the vehicle\",\n    \"6-1\": \"Address of the location where the DTC was generated\",\n    \"7-1\": \"DTC generation timestamp in milliseconds\",\n    \"8-1\": \"Diagnostic troubleshooting code (DTC) reported by the vehicle\",\n    \"9-0\": \"deviceId\",\n    \"10-0\": \"description\",\n    \"11-0\": \"assetno\",\n    \"12-0\": \"firstName\",\n    \"13-0\": \"lastName\",\n    \"14-0\": \"parentGroup\",\n    \"15-0\": \"lat\",\n    \"9-1\": \"Unique identifier of the device plugged into the vehicle\",\n    \"10-1\": \"Short text describing the DTC\",\n    \"11-1\": \"Asset number of the vehicle\",\n    \"12-1\": \"First name of the driver\",\n    \"13-1\": \"Last name of the driver\",\n    \"14-1\": \"Parent of the vehicle’s group\",\n    \"15-1\": \"Latitude coordinate of the location where the DTC was generated\",\n    \"16-0\": \"lng\",\n    \"17-0\": \"foreParentGroup\",\n    \"18-0\": \"offset\",\n    \"19-0\": \"displayTimeZone\",\n    \"20-0\": \"group\",\n    \"16-1\": \"Longitude coordinate of the location where the DTC was generated\",\n    \"17-1\": \"Fore parent of the vehicle’s group\",\n    \"18-1\": \"Time offset in minutes\",\n    \"19-1\": \"Timezone of the vehicle\",\n    \"20-1\": \"Name of the vehicle’s group\",\n    \"21-0\": \"repairImportance\",\n    \"22-0\": \"severityLevel\",\n    \"23-0\": \"possibleCauses\",\n    \"24-0\": \"symptoms\",\n    \"25-0\": \"detailedDescription\",\n    \"21-1\": \"The priority at which the problem is to be fixed. Categorized as high, medium, and low\",\n    \"22-1\": \"The severity of the problem from a repair difficulty perspective. Categorized as hard, moderate, and easy\",\n    \"23-1\": \"Potential reasons that could have led the problem\",\n    \"24-1\": \"Indication of the problem\",\n    \"25-1\": \"Detailed description of the problem\"\n  },\n  \"cols\": 2,\n  \"rows\": 26\n}\n[/block]","updates":[],"order":5,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5797483e559b402b0044e5fc","user":"5656a3dd5656350d001d83a0","createdAt":"2016-07-26T11:23:42.416Z","category":{"sync":{"isSync":false,"url":""},"pages":["5592bda06bf22f170075b858","5593dbb99755e117000fbf3d","5593dc7a0e82e81700334e23","5631abc1fc94aa0d00e9b5e6","5631b5acbddb091700ad5de2","5631be58fc94aa0d00e9b5f5","56dfa9429cd22c0e00cab10c"],"title":"REPORTS","slug":"fleet-web","order":2,"from_sync":false,"reference":true,"_id":"5592bd7b9a68220d00f1c3db","createdAt":"2015-06-30T16:02:03.540Z","version":"559286c6c39c4b2d00127a71","__v":7,"project":"55926c913735880d005f7c65"},"githubsync":"","project":"55926c913735880d005f7c65","parentDoc":null,"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"},"__v":7}

postVehicle Diagnostics

The Diagnostic API allows you to retrieve diagnostic information and DTCs (Diagnostic Trouble Code) reported by the OBD system of your vehicle. A DTC is an alphanumeric code used to identify vehicle problems. For example, the DTC C1446 indicates a brake switch circuit failure. The API response contains information such as the diagnostic code, definition of the code, vehicle name, location, and timestamp. Diagnostic information of multiple vehicles can be obtained in a single API call.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

vehicleIds:
array of strings
Unique identifier of the vehicle. Accepts multiple vehicle IDs separated by commas. One of the following is mandatory- vehicleIds, vehicleNames,groupIds, groupNames
vehicleNames:
array of strings
Name of the vehicle. Accepts multiple names separated by commas
groupIds:
array of strings
Unique identifier of the group. Accepts multiple group IDs separated by commas
groupNames:
array of strings
Name of the vehicle’s group. Accepts multiple group names separated by commas
fromDate:
required
string
Include vehicle diagnostics for an interval starting from this timestamp. Timestamp should be in milliseconds or yyyy-mm-dd hh:mm:ss format
toDate:
required
string
Include vehicle diagnostics for an interval up to this timestamp. Timestamp should be in milliseconds or yyyy-mm-dd hh:mm:ss format

Result Format


Documentation

[block:callout] { "type": "info", "title": "Sample Request", "body": "https://api.azuga.com/azuga-ws/v1/diagnostics.json" } [/block] [block:code] { "codes": [ { "code": "{ \n \"vehicleIds\":[ \n \"ad965910-3685-11e5-b8e2-c5b6a804c369\",\n \"cc24608d-dc14-11e4-bf2b-435f55649c28\"\n ],\n \"fromDate\":\"2016-06-20 00:00:00\",\n \"toDate\":\"2016-06-21 23:59:00\"\n}\n", "language": "json" } ] } [/block] ##API Response explanation [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "code", "0-1": "API Status Code", "1-0": "message", "2-0": "reason", "3-0": "generatedAt", "4-0": "dtcMessageId", "1-1": "API Message (Success/Failure)", "2-1": "Reason for failure", "3-1": "API generation timestamp in UTC", "4-1": "Message ID (internal reference)", "5-0": "vehicle", "6-0": "address", "7-0": "DateTime", "8-0": "code", "5-1": "Name of the vehicle", "6-1": "Address of the location where the DTC was generated", "7-1": "DTC generation timestamp in milliseconds", "8-1": "Diagnostic troubleshooting code (DTC) reported by the vehicle", "9-0": "deviceId", "10-0": "description", "11-0": "assetno", "12-0": "firstName", "13-0": "lastName", "14-0": "parentGroup", "15-0": "lat", "9-1": "Unique identifier of the device plugged into the vehicle", "10-1": "Short text describing the DTC", "11-1": "Asset number of the vehicle", "12-1": "First name of the driver", "13-1": "Last name of the driver", "14-1": "Parent of the vehicle’s group", "15-1": "Latitude coordinate of the location where the DTC was generated", "16-0": "lng", "17-0": "foreParentGroup", "18-0": "offset", "19-0": "displayTimeZone", "20-0": "group", "16-1": "Longitude coordinate of the location where the DTC was generated", "17-1": "Fore parent of the vehicle’s group", "18-1": "Time offset in minutes", "19-1": "Timezone of the vehicle", "20-1": "Name of the vehicle’s group", "21-0": "repairImportance", "22-0": "severityLevel", "23-0": "possibleCauses", "24-0": "symptoms", "25-0": "detailedDescription", "21-1": "The priority at which the problem is to be fixed. Categorized as high, medium, and low", "22-1": "The severity of the problem from a repair difficulty perspective. Categorized as hard, moderate, and easy", "23-1": "Potential reasons that could have led the problem", "24-1": "Indication of the problem", "25-1": "Detailed description of the problem" }, "cols": 2, "rows": 26 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}