Prerequisites
To access the Accreditation Driver 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 driver mapping findCustomer API from the Accreditation Service
The accreditation driver mapping findCustomer API is exposed from the Accreditation Driver Mapping controller from the NHVR Portal - Accreditation Service.
Every call to the accreditation driver 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}/accreditationDriverMapping-customer endpoint uses the POST method and passes in a filter AccreditationDriverMappingViewCustomer
{
"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}/accreditationDriverMapping-customer
Specification
The full accreditation driver mapping findCustomer API specification is available on the NHVR Developer Platform: AccreditationDriverMappingController.findCustomer.
The return results schema is provided below for quick reference:
{
"data": [
{
"id": 1,
"accreditationId": 1,
"customerAccountId": 3,
"firstName": "John",
"name": "Smith",
"license": "123ABC",
"state": "QLD",
"operationsAccountId": 1,
"dateOfFatigueInduction": "2018-01-23T06:10:22.330Z",
"moduleBFM": true,
"moduleAFM": false,
"status": null,
"lastDateInBFM": null
"lastDateInAFM": null,
"lastDateOutBFM": null,
"lastDateOutAFM": null,
"lastUpdatedDateBFM": null,
"lastUpdatedDateAFM": null,
"medicalCertificateDate": null,
"medicalCertificateExpiryDate": null,
"hasModuleAFM": "No",
"hasModuleBFM": "Yes"
}
],
"count": 1,
"filter": {
"limit": 50,
"skip": 0
},
"views": [],
"selectedView": {
"queryTypename": "AccreditationDriverMappingViewCustomer",
"queryViewSystemId": 0,
"queryViewAccountId": 0,
"name": "Default view",
"description": "Default view automatically created",
"locked": false,
"autoSave": false,
"archived": false,
"id": 56,
"viewType": "User"
}
}