Prerequisites
To access the Accreditation Compliance Mapping 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 accreditation compliance mapping findCustomer API from the Accreditation Service
The accreditation compliance mapping findCustomer API is exposed from the Accreditation Compliance Mapping controller from the NHVR Portal - Accreditation Service.
Every call to the accreditation compliance mapping 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 accreditations/{id}/accreditationComplianceMapping-customer endpoint uses the POST method and passes in a filter AccreditationComplianceMapping
{
"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.
The id (accreditationId) path parameter is required to perform a search.
https://api-public.nhvr.gov.au/accred/accreditations/{id}/accreditationComplianceMapping-customer
Specification
The full accreditation compliance mapping findCustomer API specification is available on the NHVR Developer Platform: AccreditationComplianceMappingController.findCustomer.
The return results schema is provided below for quick reference:
{
"data": [
{
"id": 1,
"accreditationId": 1,
"customerAccountId": 3,
"firstName": "Steve",
"name": "Lock",
"operatorName": null,
"complianceHistoryType": null,
"otherRegistrations": null,
"vehicleRegistration": null,
"vehicleRegistrationState": null,
"interceptOfficer": null,
"interceptOfficerId": null,
"interceptReportNumber": null,
"interceptOfficerType": null,
"interceptOfficerState": null,
"offenceType": "Overloading",
"offence": null,
"locationLine1": "Nudgee 4024",
"locationLocality": null,
"locationState": null,
"locationPostalCode": null,
"reference": "",
"dateOfOffence": "2017-03-21T06:10:22.330Z",
"status": null
},
{
"id": 2,
"accreditationId": 1,
"customerAccountId": 3,
"firstName": "Mark",
"name": "Smith",
"operatorName": null,
"complianceHistoryType": null,
"otherRegistrations": null,
"vehicleRegistration": null,
"vehicleRegistrationState": null,
"interceptOfficer": null,
"interceptOfficerId": null,
"interceptReportNumber": null,
"interceptOfficerType": null,
"interceptOfficerState": null,
"offenceType": "Vehicle Safety",
"offence": null,
"locationLine1": "1 Queen Street Mall, 90-112 Queen St, Brisbane City QLD 4000",
"locationLocality": null
"locationState": null,
"locationPostalCode": null,
"reference": "Test1",
"dateOfOffence": "2019-04-01T06:10:22.330Z",
"status": null
}
],
"count": 2,
"filter": {
"limit": 50,
"skip": 0
},
"views": [],
"selectedView": {
"queryTypename": "AccreditationComplianceMappingViewCustomer",
"queryViewSystemId": 0,
"queryViewAccountId": 0,
"name": "Default view",
"description": "Default view automatically created",
"locked": false,
"autoSave": false,
"archived": false,
"id": 59,
"viewType": "User"
}
}