Prerequisites
To access the Vehicle Defects findByContainerCustomer 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 findByContainerCustomer API from the Vehicle Service
The vehicle defects findByContainerCustomer API is exposed from the Vehicle Defect controller from the NHVR Portal - Vehicle Service.
Every call to the vehicle defects findByContainerCustomer 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 accreditations/{id}/vehicleDefects-customer endpoint uses the POST method and passes in a VehicleDefectAccreditationViewCustomer filter
{
"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/accreditations/{id}/vehicleDefects-customer
Specification
The full vehicle defects customer API specification is available on the NHVR Developer Platform: VehicleDefectController.findByContainerCustomer.
The return results schema is provided below for quick reference:
{
"data": [
{
"id": null,
"vehicleDefectId": null,
"reasonDescription": null,
"nhvimComponent": null,
"accreditationId": 6,
"registrationJurisdiction": "ACT",
"registrationPlateNumber": "YDC91A",
"registrationEndDate": null,
"registeredOwner": "SIMON TRANSPORT PTY LTD",
"customerAccountId": 22,
"vehicleId": "ACT1054",
"incidentDate": "2024-11-06",
"defectIssuingAgency": "ACT Agency",
"defectIssuingJurisdiction": "ACT",
"defectNoticeNumber": "XYZ2233",
"plateNumber": "YDC91A",
"defectSeverityCode": "SC",
"defectStatusCode": "DC",
"clearedDate": "2024-11-07",
"inspectionCertificateNumber": "G323888",
"authorisedStationName": "Canberra",
"moduleMass": true,
"moduleMaintenance": false
},
{
"id": null,
"vehicleDefectId": null,
"reasonDescription": null,
"nhvimComponent": null,
"accreditationId": 6,
"registrationJurisdiction": "ACT",
"registrationPlateNumber": "YDC91A",
"registrationEndDate": null,
"registeredOwner": "SIMON TRANSPORT PTY LTD",
"customerAccountId": 3,
"vehicleId": "ACT1054",
"incidentDate": "2024-11-06",
"defectIssuingAgency": "ACT Agency",
"defectIssuingJurisdiction": "ACT",
"defectNoticeNumber": "XYZ2233",
"plateNumber": "YDC91A",
"defectSeverityCode": "SC",
"defectStatusCode": "DC",
"clearedDate": "2024-11-07",
"inspectionCertificateNumber": "G323888",
"authorisedStationName": "Canberra",
"moduleMass": true,
"moduleMaintenance": false
},
],
"count": 2,
"filter": {
"limit": 50,
"skip": 0
},
"views": [
{
"id": 23,
"viewType": "User",
"queryViewUserId": 23,
"name": "Default view",
"description": "Default view automatically created",
"locked": false,
"subFilterId": null,
"columns": null,
"density": null,
"viewMode": null,
"autoSave": false,
"archived": false
}
],
"selectedView": {
"id": 23,
"viewType": "User",
"queryViewUserId": 23,
"name": "Default view",
"description": "Default view automatically created",
"locked": false,
"subFilterId": null,
"columns": null,
"density": null,
"viewMode": null,
"autoSave": false,
"archived": false
}
}