AusRoads

FREE
By Health Tech HQ | Updated a month ago | Business
Health Check

N/A

README

Endpoints
1. Lookup by Function and State
This endpoint allows users to perform vehicle information lookups based on the specified function and state. The API will route the request to the appropriate function and state combination.

Endpoint: /lookup

Method: POST

Request Parameters:

function (string, required): Specifies the type of lookup to perform. Possible values are:
"VIN": Performs a partial Vehicle Identification Number (VIN) scan.
"REVS": Performs a generic registration check for Australia.
"CHPPSR": Performs a flexible internal registration check for Australia.
"PPSR": Performs a generic registration check for Australia.
"NEVDIS": Performs a second registration check for Australia.
"ALT": Performs a third registration check for Australia.
"NT": Performs a registration check for the Northern Territory.
"QLD": Performs a registration check for Queensland.
"S": Performs a registration check for a car in Victoria.
"C": Performs a registration check for a motorcycle in Victoria.
"T": Performs a registration check for a trailer in Victoria.
Request Body:

json
Copy code
{
  "function": "VIN",
  "state": "NSW",
  "plate": "ABC123"
}
Response:
The response will contain information related to the vehicle based on the function and state combination.

2. Lookup by State
This endpoint allows users to perform vehicle information lookups based on the specified state only. The API will route the request to the appropriate state-specific function.

Endpoint: /lookup/state

Method: POST

Request Parameters:

state (string, required): Specifies the state in Australia for which the registration check is to be performed. Possible values are:
"ACT": Australian Capital Territory
"NSW": New South Wales
"NT": Northern Territory
"QLD": Queensland
"SA": South Australia
"WA": Western Australia
Request Body:

json

{
  "state": "QLD",
  "plate": "XYZ789"
}
Response:
The response will contain information related to the vehicle based on the state-specific function.

Error Handling
If an unknown function or state is provided in the request, the API will respond with an HTTP status code 400 Bad Request and a JSON error message indicating the issue.
Example Error Response:

json
Copy code
{
  "error": "Unknown function or state"
}
Example Usage
Request:


Copy code
POST https://api.vehicleinfo.com/lookup
Request Body:

json

{
  "function": "S",
  "state": "VIC",
  "plate": "XYZ456"
}
Response:

json

{
  "make": "Toyota",
  "model": "Corolla",
  "year": "2018",
  "color": "Silver",
  "registration_status": "Active",
  "registration_expiry": "2023-12-31"
}

Followers: 1
Resources:
Product Website
API Creator:
H
Health Tech HQ
cr3mj6fak5
Log In to Rate API
Rating: 5 - Votes: 1