Prerequisites
To access the permit controller findByid 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 permit findById API from the Access Service
The permit findById API is exposed from the Permit controller from the NHVR Portal - Access Service.
Every call to the permit findById 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 findById endpoint uses the GET method and has one path parameter id
id
The permit id path parameter is required to perform a search.
https://api-public.nhvr.gov.au/access/permits/{id}
Specification
The full permit findById API specification is available on the NHVR Developer Platform: PermitController.findById.
The return results schema is provided below for quick reference:
{
"ip": "127.0.0.1",
"created": "2021-04-15T14:49:32.967Z",
"modified": null,
"modifiedOffline": null,
"createdBy": 92,
"modifiedBy": null,
"id": 2,
"fileList": null,
"customerAccountId": 8,
"accessVehicleExemptionSetId": null,
"permitFileList": [
"operations8053Permit_8053V1_07Jul25.pdf",
"operations7010Permit_7010V1_09Jul25.pdf",
"operations8054Permit_8054V1_09Jul25.pdf"
],
"status": "Submitted",
"templateGroupGenId": null,
"templateLinkId": null,
"issuer": null,
"permitNumber": null,
"permitVersion": null,
"caseNumber": "10008061",
"vehicleClass": null,
"previousCustomerAccountId": null,
"productTypeId": 1,
"submitted": "2021-04-15T14:49:32.967Z",
"channel": "Portal",
"workGroupId": null,
"assignedTo": 63,
"operationsAccountId": 1,
"workflowState": 42,
"previousWorkflowState": 9,
"applicationClass": "New Permit",
"applicationType": "B-Double",
"osomType": null,
"roadTrainType": null,
"vehicleComponentSetTypeId": "13",
"contactUserId": 92,
"name": "Permit container",
"description": null,
"code": null,
"periodFrom": "2021-05-16",
"periodTo": "2022-04-16",
"permitExpiry": null,
"permitRenewalPeriod": null,
"width": null,
"length": 1259,
"height": 4,
"widthUnladen": null,
"lengthUnladen": null,
"heightUnladen": null,
"heightReason": null,
"forwardProjectionRequired": null,
"forwardProjection": null,
"wheelbase": null,
"rearOverhangRequired": null,
"rearOverhang": null,
"tareMass": null,
"totalMass": null,
"maxMassOfLoad": null,
"totalMassCertification": null,
"freightType": "None",
"loadType": null,
"bodyType": null,
"volumetric": null,
"complianceEuroVI": null,
"removedParts": null,
"counterWeights": null,
"numberOfItems": null,
"loadDescription": null,
"livestockLoadScheme": null,
"livestockLoadAllEnrolled": null,
"iAP": null,
"iAPState": "",
"permitSchemesState": "",
"permitScheme": "",
"otherPermitSchemes": null,
"period": null,
"pushPullTrucksRequired": null,
"operatingConvoy": null,
"numberOfTrips": null,
"operatingJurisdiction": null,
"operateBDoubleNetwork": null,
"returnTripRequired": null,
"nightTravelOption": null,
"nightTravelReason": null,
"thirdPartyConsent": null,
"travelRecord": null,
"pbsApprovalType": null,
"pbsDesignApprovalNumber": null,
"pbsFinalApprovalNumber": null,
"pbsFinalApprovalVersion": null,
"pbsOperatingMassAndAccessLevel": null,
"pbsFinalApprovalUpdate": null,
"pbsConfigurationUpdate": null,
"pbsNetworkOrRoute": null,
"pbsNetworkJurisdiction": null,
"pbsLevel": null,
"pbsBridgeTier": null,
"pbsRouteLimit": null,
"pbsRouteMass": null,
"customerVehicleSetItem": [
{
"id": 0,
"customerVehicleSetId": -1,
"vehicleComponentId": 82,
"confirmComponent": true,
"customerVehicles": [],
"spec": null
},
{
"id": -1,
"customerVehicleSetId": -1,
"vehicleComponentId": 17,
"confirmComponent": true,
"customerVehicles": [],
"spec": null
},
{
"id": -2,
"customerVehicleSetId": -1,
"vehicleComponentId": 95,
"confirmComponent": true,
"customerVehicles": [],
"spec": null
}
],
"customerVehicle": null,
"routeType": "Single Route",
"routeId": "IVHY-5",
"routeVersion": 1,
"routeWaypoints": null,
"mapState": null,
"areaPartnerAccountId": null,
"road": null,
"customRoadSummary": null,
"condition": null,
"lastEventId": null,
"lastEventLabel": null,
"autoIssue": null,
"autoIssueExecuted": null,
"autoRenewExecuted": null,
"autoAmendExecuted": null,
"systemGenerated": null,
"customerAccount": {
"id": 8,
"rCN": 12345669,
"name": "NHVR Accred Account 3 for Auto Tests"
}
}