Skip to main content

NHVR Portal API – Network findById

How to use the Network controller findById method

Updated this week

Prerequisites

To access the Network 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 network findById API from the Network Service

The network findById API is exposed from the Network controller from the NHVR Portal - Network Service.

Every call to the network 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 network/networks/{id} endpoint uses the GET method and passes in a mandatory path parameter id (networkId). Optional query parameters accessProductDocumentId and accessProductApplicationId can also be included in the endpoint.

https://api-public.nhvr.gov.au/network/networks/{id}

Specification

The full network find API specification is available on the NHVR Developer Platform: NetworkController.findById.

The return results schema is provided below for quick reference:

{
"submittedBy": null,
"submitted": null,
"ip": "10.9.2.253",
"activatedDate": "2022-04-20T06:06:00.373Z",
"retiredDate": null,
"modifiedBy": "postgres",
"modified": "2025-08-22T02:44:46.089Z",
"createdBy": "postgres",
"created": "2022-04-20T06:06:00.373Z",
"networkId": 8,
"networkName": "TwoD_9PT",
"networkDisplayName": "TwoD_9PT",
"description": null,
"richDescription": null,
"networkType": "PreApproval",
"status": "Published",
"createdPartnerAccountId": null,
"operationsAccountId": 1,
"networkWkid": 71370005,
"networkTags": "\"SourceOfTruth\"=>\"True\", \"PortalSpatialNetworkManagementVisibility\"=>\"False\"",
"publishedBy": "176",
"publishedDate": "2025-08-22T02:44:45.489Z",
"fileList": null,
"accessProductDocumentId": -1,
"accessProductDocument": {
"id": 1825,
"accessInstrumentId": 132,
"accessVehicleExemptionSetId": 1810,
"generalAccess": false,
"networkId": 8,
"etlNetworkId": null,
"name": "Prime mover towing 2x8 dolly and 5x8 platform trailer, up to 6m in width, up to 32m in length, min 4.2 GCW, up to 131.0t",
"description": null,
"startDate": null,
"expiryDate": null,
"condition": [],
"accessInstrument": {
"id": 132,
"policyType": "Pre-approval",
"name": "Victoria Class 1 Platform Trailer Single Trip Permit Pre-approval",
"description": "Victoria’s platform trailer networks provide pre-approved permit access for a range of platform trailer configurations up to 206.0t on key corridors.",
"startDate": null,
"expiryDate": null,
"actualExpiryDate": null,
"status": "Current",
"condition": [],
"comLawRefNum": "INS132",
"transitional": null,
"exemptionTypes": [],
"approval": "Gazette Request",
"publicationUrl": null,
"guideUrl": "https://transport.vic.gov.au/business/heavy-vehicles/heavy-vehicle-contacts-and-resources/victorias-platform-trailer-network"
},
"accessVehicleExemptionSet": {
"id": 1810,
"name": "Prime mover towing 2x8 dolly and 9x8 platform trailer, up to 6m in width, up to 40m in length, min 4.3m GCW, up to 191.0t",
"description": "Oversize and Overmass Prime mover (no tri-drive) towing dolly and platform trailer (with/without block truck)",
"vehicleComponentSetTypeId": 29,
"configurationBuild": {
"configuration": {
"id": null,
"vehicleComponentSetTypeId": 29,
"vehicleComponentSetType": {
"id": 29,
"configurationType": "Custom",
"name": "Custom"
},
"width": 2.5,
"length": null,
"height": null,
"widthUnladen": null,
"lengthUnladen": null,
"heightUnladen": null,
"forwardProjection": null,
"rearOverhang": null,
"wheelbase": null,
"tareMass": null,
"totalMass": null,
"spec": [
{
"vehicleComponentId": 82,
"vehicleComponent": {
"id": 82,
"componentType": "Hauling",
"name": "Prime mover 1-2 axle",
"shortName": "Tandem drive prime mover",
"fileList": {
"vehicleImageUrl": "https://nhvrappsprod.blob.core.windows.net/vehicle-components/82.png"
},
"vehicleComponentTypeId": 13,
"name": "Prime mover 1-2 axle",
"axleGroups": [
{
"group": "Steer",
"axleSpread": null,
"tyreSize": null,
"contactWidth": null,
"axleMassUnladen": null,
"axleMass": null,
"loadSharing": null,
"hydroPneumatic": null,
"steer": true,
"tyreSizeTxt": null,
"trackWidth": null,
"dualTyreSpacing": null,
"maxAxleMass": null,
"maxSuspensionAxleMass": null,
"tractiveEffortDist": null,
"certifiedRFSuspension": true,
"nswTonneSteer": false,
"axles": [
{
"tyres": 2,
"spacing": null,
"trackWidth": null,
"dualTyreSpacing": null,
"tyreSize": null,
"mass": null,
"massUnladen": null,
"drive": null,
"steer": "",
"steerOptional": false,
"liftable": false,
"liftableOptional": false,
"loadSharing": null
},
{
"group": "Drive",
"axleSpread": null,
"tyreSize": null,
"contactWidth": null,
"axleMassUnladen": null,
"axleMass": null,
"loadSharing": null,
"hydroPneumatic": null,
"steer": null,
"tyreSizeTxt": null,
"tyreSizeTxt": null,
"trackWidth": null,
"dualTyreSpacing": null,
"maxAxleMass": null,
"maxSuspensionAxleMass": null,
"tractiveEffortDist": null,
"certifiedRFSuspension": true,
"nswTonneSteer": false,
"axles": [
{
"tyres": 2,
"spacing": null,
"trackWidth": null,
"dualTyreSpacing": null,
"tyreSize": null,
"mass": null,
"massUnladen": null,
"drive": null,
"steer": "",
"steerOptional": false,
"liftable": false,
"liftableOptional": false,
"loadSharing": null
},
{
"tyres": 2,
"spacing": null,
"trackWidth": null,
"dualTyreSpacing": null,
"tyreSize": null,
"mass": null,
"massUnladen": null,
"drive": null,
"steer": "",
"steerOptional": false,
"liftable": false,
"liftableOptional": false,
"loadSharing": null
}
]
}
],
"width": null,
"length": null,
"forwardOverhang": null,
"forwardOverhangRadius": null,
"wheelbase": null,
"rearOverhang": null,
"towRearOverhang": null,
"drawbarLength": null,
"sDimension": null,
"fifthWheelOffset": null,
"heightFront": null,
"heightRear": null,
"heightFrontFloor": null,
"heightRearFloor": null,
"heightDrawbar": null,
"tareMass": null,
"totalMass": null,
"canReduceTotalMass": null,
"grossCombinationMass": null,
"bodyType": null,
"loads": [],
"volumetric": null,
"numberOfDecks": null
}
],
"compliances": [
"complying steer axle vehicle"
],
"eligibilities": []
},
"massLimits": [],
"vehicleComponentDetails": [],
"vehicleComponentRegistrations": []
},
"condition": [],
"exemptionRuleSet": "",
"vehicleClass": [
"Class 1"
],
"osomType": [
"Oversize and Overmass (OSOM)"
],
"roadTrainType": [],
"freightType": [],
"loadType": [
"Indivisible"
],
"width": 6,
"length": 40,
"height": 6,
"operationsAccountId": 1,
"isAllowedOnBusways": null,
"isAllowedOnEmergencyAccess": null
}
}
}



Did this answer your question?