Prerequisites
To access the Vehicle Defects findCustomer method, you need to establish an API user to access the NHVR Developer Platform. For a step by step guide see Logging into the Developer Platform.
Using the vehicle defects findCustomer API from the Vehicle Service
The vehicle defects customer API is exposed from the Vehicle Defect controller from the NHVR Portal - Vehicle Service.
Every call to the vehicle defects findCustomer API should include the following headers:
Header | Value | Note |
Content-Type | 'application/json' | All calls are made using JSON data structures |
Ocp-Apim-Subscription-Key | Your subscription key for the NHVR Portal API | The subscription key uniquely identifies you to the NHVR Portal API |
The vehicleDefects-customer endpoint uses the POST method and passes in a filter request body, which can be an empty VehicleDefectViewCustomer JSON request body {}.
{
"id":0,
"viewAction":"",
"viewType":"User",
"queryViewUserId":0,
"queryViewAccountId":0,
"queryViewSystemId":0,
"name":"string",
"description":"string",
"locked":false,
"subFilterId":"string",
"columns":[
{
"field":"string",
"size":0,
"hidden":false,
"pinned":""
}
],
"density":"standard",
"viewMode":"Table",
"utcOffset":0,
"silentUpdate":false,
"autoSave":false
}
The filter parameter is required to perform the search but can be an empty {} object.
https://api-public.nhvr.gov.au/vehicle/vehicleDefects-customer
Specification
The full vehicle defects findCustomer API specification is available on the NHVR Developer Platform: VehicleDefectController.vehicleDefects-customer.
The return results schema is provided below for quick reference:
{
"data": [
{
"id": 1,
"vehicleDefectId": 1,
"reasonDescription": "Brakes",
"nhvimComponent": "2 - Brakes",
"registrationJurisdiction": "ACT",
"registrationPlateNumber": "YZO460",
"registrationEndDate": "2018-11-01T00:00:00.000Z",
"customerAccountId": 1,
"vehicleId": "ACT1",
"incidentDate": "2021-10-05",
"defectIssuingAgency": "AC",
"defectIssuingJurisdiction": "ACT",
"defectNoticeNumber": "HV2012717",
"plateNumber": "YHX94G",
"defectSeverityCode": "Minor",
"defectStatusCode": "SWS",
"clearedDate": "2021-11-06",
"inspectionCertificateNumber": "G323525",
"authorisedStationName": "GOVERNMENT INSPECTION STATION"
},
{
"id": 2,
"vehicleDefectId": 2,
"reasonDescription": "Suspension",
"nhvimComponent": "4 - Steering and suspension",
"registrationJurisdiction": "NSW",
"registrationPlateNumber": "YEW51J",
"registrationEndDate": "2017-05-08T00:00:00.000Z",
"registeredOwner": "SAFE JOURNEY AUSTRALIA PTY LTD",
"customerAccountId": 1,
"vehicleId": "ACT10",
"incidentDate": "2021-11-06",
"defectIssuingAgency": "AC",
"defectIssuingJurisdiction": "QLD",
"defectNoticeNumber": "HV2012718",
"plateNumber": "T0988E",
"defectSeverityCode": "SC",
"defectStatusCode": "DC",
"clearedDate": "2021-11-07",
"inspectionCertificateNumber": "G323526",
"authorisedStationName": "Brisbane"
},
{
"id": 3,
"vehicleDefectId": 1,
"reasonDescription": "test",
"nhvimComponent": "4 - Steering and suspension",
"registrationJurisdiction": "ACT",
"registrationPlateNumber": "YZO460",
"registrationEndDate": "2018-11-01T00:00:00.000Z",
"registeredOwner": "GARED X BAKER CONTRACTING PTY LTD",
"customerAccountId": 1,
"vehicleId": "ACT1",
"incidentDate": "2021-10-05",
"defectIssuingAgency": "AC",
"defectIssuingJurisdiction": "ACT",
"defectNoticeNumber": "HV2012717",
"plateNumber": "YHX94G",
"defectSeverityCode": "Minor",
"defectStatusCode": "SWS",
"clearedDate": "2021-11-06",
"inspectionCertificateNumber": "G323525",
"authorisedStationName": "GOVERNMENT INSPECTION STATION"
}
],
"count": 3,
"filter": {
"limit": 50,
"skip": 0
},
"views": [],
"selectedView": {
"queryTypename": "VehicleDefectViewCustomer",
"queryViewSystemId": 0,
"queryViewAccountId": 0,
"name": "Default view",
"description": "Default view automatically created",
"locked": false,
"autoSave": false,
"archived": false,
"id": 24,
"viewType": "User"
}
}