National Highway Traffic Safety Administration Vehicle Data Connector

info@ismena.com

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The National Highway Traffic Safety Administration (NHTSA) Vehicle Data Connector facilitates seamless integration with the NHTSA Vehicle Product Information Catalog (vPIC) Vehicle API, a U.S.-based service providing access to vehicle information, VIN decoding, manufacturer details, makes, models, parts, and specifications for vehicles primarily in the United States. This connector acts as a proxy to streamline data retrieval, supporting actions for decoding VINs, querying manufacturers, and fetching vehicle types and models. It supports JSON, XML, and CSV response formats.

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the NHTSA vPIC Connector.r.
Supported Integration Action Points

decodeVin: Decode a VIN to extract vehicle information.
decodeVinValues: Decode a VIN in flat format.
decodeVinExtended: Decode a VIN with extended information.
decodeVinValuesExtended: Decode a VIN in flat format with extended information.
decodeWmi: Decode a World Manufacturer Identifier (WMI).
getWmisForManufacturer: Get WMIs for a specific manufacturer.
getAllMakes: Get all vehicle makes.
getParts: Get parts information.
getAllManufacturers: Get all manufacturers.
getManufacturerDetails: Get details for a specific manufacturer.
getVehicleTypesForMake: Get vehicle types for a make.
getVehicleTypesForMakeId: Get vehicle types for a make ID.
getEquipmentPlantCodes: Get equipment plant codes.
getMakesForManufacturer: Get makes for a manufacturer.
getMakesForManufacturerAndYear: Get makes for a manufacturer and year.
getMakesForVehicleType: Get makes for a vehicle type.
getModelsForMake: Get models for a make.
getModelsForMakeId: Get models for a make ID.
getModelsForMakeYearMakeModelYear: Get models for a make and model year.
getModelsForMakeYearMakeVehicleType: Get models for a make and vehicle type.
getModelsForMakeYearModelYearVehicleType: Get models for a model year and vehicle type.
getModelsForMakeIdYearMakeIdModelYear: Get models for a make ID and model year.
getModelsForMakeIdYearMakeIdVehicleType: Get models for a make ID and vehicle type.
getModelsForMakeIdYearModelYearVehicleType: Get models for a model year and vehicle type.
getVehicleVariableList: Get list of vehicle variables.
getVehicleVariableValuesList: Get values for a vehicle variable.
decodeVinValuesBatch: Decode multiple VINs in batch.
getCanadianVehicleSpecifications: Get Canadian vehicle specifications.

Detailed Integration Documentation

2.1 Decode Vin Retrieval

Action	decodeVin
Purpose	Decodes a VIN to extract vehicle information like make, model, and specifications. This serves as a primary tool for vehicle data lookup.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_NHTSAVPIC_BASE_URL` environment variable.
Parameters	Required: vin: The VIN to decode (string). Optional: format: Response format (string, enum: [xml, json, csv]). modelyear: Model year (integer).
Output	Successful: Returns a JSON, XML, or CSV object with: Count: Number of results (integer). Message: Response message (string). SearchCriteria: Query details (string). Results: Array of vehicle attribute objects (Make, Model, ModelYear, etc.). Failure: Returns error details (e.g., invalid VIN).
Workflow Example	Configure the connector with the appropriate base URL. Execute the `decodeVin` action with `vin=5UXWX7C5*BA` and optional `format=json`. Process the response to display vehicle details.

2.2 Decode Vin Values Retrieval

Action	decodeVinValues
Purpose	Decodes a VIN in flat format for concise vehicle information retrieval.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_NHTSAVPIC_BASE_URL` environment variable.
Parameters	Required: vin: The VIN to decode (string). Optional: format: Response format (string, enum: [xml, json, csv]). modelyear: Model year (integer).
Output	Successful: Returns a JSON, XML, or CSV object with: Count: Number of results (integer). Message: Response message (string). SearchCriteria: Query details (string). Results: Array of flat key-value pairs for vehicle attributes. Failure: Returns error details (e.g., invalid VIN).
Workflow Example	Execute the `decodeVinValues` action with `vin=5UXWX7C5*BA`. Review the flat format response. Use the data for quick lookups.

2.3 Decode Vin Extended Retrieval

Action	decodeVinExtended
Purpose	Decodes a VIN with extended vehicle information for detailed analysis.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_NHTSAVPIC_BASE_URL` environment variable.
Parameters	Required: vin: The VIN to decode (string). Optional: format: Response format (string, enum: [xml, json, csv]). modelyear: Model year (integer).
Output	Successful: Returns a JSON, XML, or CSV object with: Count: Number of results (integer). Message: Response message (string). SearchCriteria: Query details (string). Results: Array of extended vehicle attribute objects. Failure: Returns error details (e.g., invalid VIN).
Workflow Example	Execute the `decodeVinExtended` action with `vin=5UXWX7C5*BA`. Process the extended details. Integrate into detailed reporting tools.

2.4 Decode Vin Values Extended Retrieval

Action	decodeVinValuesExtended
Purpose	Decodes a VIN in flat format with extended information for comprehensive yet concise data.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: vin: The VIN to decode (string). Optional: format: Response format (string, enum: [xml, json, csv]). modelyear: Model year (integer).
Output	Successful: Count: Number of results (integer). Message: Response message (string). SearchCriteria: Query details (string). Results: Array of flat key-value pairs with extended attributes. Failure: Returns error details (e.g., invalid VIN).
Workflow Example	Execute `decodeVinValuesExtended` action with `vin=5UXWX7C5*BA`. Save the extended flat data. Use for data processing applications.

2.5 Decode Wmi Retrieval

Action	decodeWmi
Purpose	Decodes a World Manufacturer Identifier (WMI) to get manufacturer and country details.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: wmi: The WMI to decode (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of WMI details (WMI, Manufacturer, Country). Failure: Returns error details (e.g., invalid WMI).
Workflow Example	Execute `decodeWmi` action with `wmi=1G1`. Review the manufacturer information. Use for supply chain analysis.

2.6 Get Wmis For Manufacturer Retrieval

Action	getWmisForManufacturer
Purpose	Retrieves WMIs associated with a manufacturer, optionally filtered by vehicle type.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: manufacturer: Manufacturer name or ID (string). Optional: vehicleType: Vehicle type (string). format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of WMI objects (WMI, Manufacturer, VehicleType). Failure: Returns error details (e.g., invalid manufacturer).
Workflow Example	Execute `getWmisForManufacturer` action with `manufacturer=honda`. List the WMIs. Use for manufacturer verification.

2.7 Get All Makes Retrieval

Action	getAllMakes
Purpose	Retrieves a list of all vehicle makes.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: None Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of make objects (Make_ID, Make_Name). Failure: Returns error details.
Workflow Example	Execute `getAllMakes` action with optional `format=json`. Populate a make selection dropdown. Use for vehicle search interfaces.

2.8 Get Parts Retrieval

Action	getParts
Purpose	Retrieves parts information filtered by type, date range, and manufacturer.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: None Optional: type: Part type (string). fromDate: Start date (string, format: date). toDate: End date (string, format: date). format: Response format (string, enum: [xml, json, csv]). page: Page number (integer). manufacturer: Manufacturer (string).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of part objects (PartId, PartName, Manufacturer, Date). Failure: Returns error details.
Workflow Example	Execute `getParts` action with `type=565` and `fromDate=1/1/2015`. Analyze parts data. Use for safety recalls.

2.9 Get All Manufacturers Retrieval

Action	getAllManufacturers
Purpose	Retrieves a list of all manufacturers, optionally filtered by type and paginated.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: None Optional: ManufacturerType: Manufacturer type (string). format: Response format (string, enum: [xml, json, csv]). page: Page number (integer).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of manufacturer objects (ManufacturerId, ManufacturerName, ManufacturerType). Failure: Returns error details.
Workflow Example	Execute `getAllManufacturers` action with `ManufacturerType=Intermediate`. List manufacturers. Use for industry overviews.

2.10 Get Manufacturer Details Retrieval

Action	getManufacturerDetails
Purpose	Retrieves detailed information for a specific manufacturer.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: manufacturer: Manufacturer name or ID (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of manufacturer details (ManufacturerId, ManufacturerName, Country, Address). Failure: Returns error details (e.g., invalid manufacturer).
Workflow Example	Execute `getManufacturerDetails` action with `manufacturer=honda`. Review details. Use for compliance checks.

2.11 Get Vehicle Types For Make Retrieval

Action	getVehicleTypesForMake
Purpose	Retrieves vehicle types for a specific make.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: make: Make name (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of vehicle type objects (VehicleTypeId, VehicleTypeName). Failure: Returns error details (e.g., invalid make).
Workflow Example	Execute `getVehicleTypesForMake` action with `make=honda`. List types. Use for categorization.

2.12 Get Vehicle Types For Make Id Retrieval

Action	getVehicleTypesForMakeId
Purpose	Retrieves vehicle types for a specific make ID.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: makeId: Make ID (integer). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of vehicle type objects (VehicleTypeId, VehicleTypeName). Failure: Returns error details (e.g., invalid make ID).
Workflow Example	Execute `getVehicleTypesForMakeId` action with `makeId=474`. Process types. Integrate into search filters.

2.13 Get Equipment Plant Codes Retrieval

Action	getEquipmentPlantCodes
Purpose	Retrieves equipment plant codes for a given year, type, and report type.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: year: Year (integer). equipmentType: Equipment type (integer). reportType: Report type (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of plant code objects (PlantCode, PlantName, Year). Failure: Returns error details.
Workflow Example	Execute `getEquipmentPlantCodes` action with `year=2015`, `equipmentType=1`, `reportType=all`. Analyze codes. Use for manufacturing tracking.

2.14 Get Makes For Manufacturer Retrieval

Action	getMakesForManufacturer
Purpose	Retrieves makes associated with a manufacturer.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: manufacturer: Manufacturer name or ID (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of make objects (Make_ID, Make_Name). Failure: Returns error details (e.g., invalid manufacturer).
Workflow Example	Execute `getMakesForManufacturer` action with `manufacturer=honda`. List makes. Use for brand analysis.

2.15 Get Makes For Manufacturer And Year Retrieval

Action	getMakesForManufacturerAndYear
Purpose	Retrieves makes for a manufacturer and specific year.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: manufacturer: Manufacturer name or ID (string). Optional: year: Year (integer). vehicleType: Vehicle type (string). format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of make objects (Make_ID, Make_Name). Failure: Returns error details.
Workflow Example	Execute `getMakesForManufacturerAndYear` action with `manufacturer=honda` and `year=2015`. Review yearly makes. Use for historical data.

2.16 Get Makes For Vehicle Type Retrieval

Action	getMakesForVehicleType
Purpose	Retrieves makes for a specific vehicle type.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: vehicleType: Vehicle type name (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of make objects (Make_ID, Make_Name). Failure: Returns error details (e.g., invalid vehicle type).
Workflow Example	Execute `getMakesForVehicleType` action with `vehicleType=car`. List makes. Use for type-specific searches.

2.17 Get Models For Make Retrieval

Action	getModelsForMake
Purpose	Retrieves models for a specific make.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: make: Make name (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name, Make_ID). Failure: Returns error details (e.g., invalid make).
Workflow Example	Execute `getModelsForMake` action with `make=honda`. List models. Use for model selection.

2.18 Get Models For Make Id Retrieval

Action	getModelsForMakeId
Purpose	Retrieves models for a specific make ID.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: makeId: Make ID (integer). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name, Make_ID). Failure: Returns error details (e.g., invalid make ID).
Workflow Example	Execute `getModelsForMakeId` action with `makeId=474`. Process models. Integrate into databases.

2.19 Get Models For Make Year Make Model Year Retrieval

Action	getModelsForMakeYearMakeModelYear
Purpose	Retrieves models for a make and model year.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: make: Make name (string). year: Model year (integer). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name). Failure: Returns error details.
Workflow Example	Execute `getModelsForMakeYearMakeModelYear` action with `make=honda` and `year=2015`. List models. Use for year-specific queries.

2.20 Get Models For Make Year Make Vehicle Type Retrieval

Action	getModelsForMakeYearMakeVehicleType
Purpose	Retrieves models for a make and vehicle type.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: make: Make name (string). vehicleType: Vehicle type (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name). Failure: Returns error details.
Workflow Example	Execute `getModelsForMakeYearMakeVehicleType` with `make=honda` and `vehicleType=car`. Review models. Use for type filtering.

2.21 Get Models For Make Year Model Year Vehicle Type Retrieval

Action	getModelsForMakeYearModelYearVehicleType
Purpose	Retrieves models for a model year and vehicle type.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: year: Model year (integer). vehicleType: Vehicle type (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name). Failure: Returns error details.
Workflow Example	Execute `getModelsForMakeYearModelYearVehicleType` with `year=2015` and `vehicleType=car`. List models. Use for broad searches.

2.22 Get Models For Make Id Year Make Id Model Year Retrieval

Action	getModelsForMakeIdYearMakeIdModelYear
Purpose	Retrieves models for a make ID and model year.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: makeId: Make ID (integer). year: Model year (integer). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name). Failure: Returns error details.
Workflow Example	Execute `getModelsForMakeIdYearMakeIdModelYear` with `makeId=474` and `year=2015`. Process models. Use for ID-based queries.

2.23 Get Models For Make Id Year Make Id Vehicle Type Retrieval

Action	getModelsForMakeIdYearMakeIdVehicleType
Purpose	Retrieves models for a make ID and vehicle type.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: makeId: Make ID (integer). vehicleType: Vehicle type (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name). Failure: Returns error details.
Workflow Example	Execute `getModelsForMakeIdYearMakeIdVehicleType` with `makeId=474` and `vehicleType=car`. List models. Use for type-specific ID queries.

2.24 Get Models For Make Id Year Model Year Vehicle Type Retrieval

Action	getModelsForMakeIdYearModelYearVehicleType
Purpose	Retrieves models for a model year and vehicle type.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: year: Model year (integer). vehicleType: Vehicle type (string). Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer). Message: Response message (string). Results: Array of model objects (Model_ID, Model_Name). Failure: Returns error details.
Workflow Example	Execute `getModelsForMakeIdYearModelYearVehicleType` with `year=2015` and `vehicleType=car`. Review models. Use for year-type combinations.

2.25 Get Vehicle Variable List Retrieval

Action	getVehicleVariableList
Purpose	Retrieves a list of vehicle variables.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: None Optional: format: Response format (string, enum: [xml, json, csv]).
Output	Successful: Count: Number of results (integer) Message: Response message (string) Results: Array of variable objects (VariableId, VariableName) Failure: Returns error details.
Workflow Example	Execute the `getVehicleVariableList` action. List variables. Use for data mapping.

2.26 Get Vehicle Variable Values List Retrieval

Action	getVehicleVariableValuesList
Purpose	Retrieves values for a specific vehicle variable.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: variable: Variable name or ID (string) Optional: format: Response format (string, enum: [xml, json, csv])
Output	Successful: Count: Number of results (integer) Message: Response message (string) Results: Array of value objects (VariableId, Value) Failure: Returns error details (e.g., invalid variable)
Workflow Example	Execute the `getVehicleVariableValuesList` action with `variable=BodyClass`. List values. Use for variable exploration.

2.27 Decode Vin Values Batch Retrieval

Action	decodeVinValuesBatch
Purpose	Decodes multiple VINs in batch for efficient processing.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: None (POST body with VINs) Optional: format: Response format (string, enum: [xml, json, csv])
Output	Successful: Count: Number of results (integer) Message: Response message (string) Results: Array of flat key-value pairs for each VIN Failure: Returns error details
Workflow Example	Execute the `decodeVinValuesBatch` action with batch VIN data. Process multiple decodes. Use for bulk operations.

2.28 Get Canadian Vehicle Specifications Retrieval

Action	getCanadianVehicleSpecifications
Purpose	Retrieves Canadian vehicle specifications filtered by year, make, model, and units.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_NHTSAVPIC_BASE_URL`.
Parameters	Required: None Optional: year: Year (integer) make: Make (string) model: Model (string) units: Units (string) format: Response format (string, enum: [xml, json, csv])
Output	Successful: Count: Number of results (integer) Message: Response message (string) Results: Array of specification objects (Make, Model, ModelYear, Specifications) Failure: Returns error details
Workflow Example	Execute the `getCanadianVehicleSpecifications` action with `year=2015` and `make=honda`. Review specs. Use for Canadian market analysis.

Workflow Creation with the Connector

Example Workflow: Vehicle Information Lookup

Retrieve Makes and Models	Use the `getAllMakes` action to fetch all makes. Use the `getModelsForMake` action with a selected make to fetch models.
Decode VIN	Execute the `decodeVin` action with a VIN to retrieve vehicle details. Use `decodeVinExtended` for more information if needed.
Query Manufacturer and Parts	Use the `getManufacturerDetails` action for manufacturer info. Use the `getParts` action to check parts by date range.
Batch Processing	Use the `decodeVinValuesBatch` action for multiple VINs. Integrate results into a vehicle database or report.

This workflow enables applications to provide users with comprehensive vehicle data, enhancing safety checks, inventory management, and compliance verification.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to Wired for Banking