Important: This documentation applies to v2 of this package.
For v3 docs see vpic.shaggytech.com

Module

api/actions/GetVehicleVariableList

GetVehicleVariableList NHSTA Api Action.

Module Exports:

Types

View Source api/actions/GetVehicleVariableList.ts, line 2

Classes

GetVehicleVariableList

Type Definitions

object

# GetVehicleVariableListResponse

Type representing the complete response returned by the GetVehicleVariableList API Action.

Properties:
Name Type Description
Count number

A count of the items returned in the Results array.

Message string

A message describing the Results array.

SearchCriteria string

Search terms (VIN, WMI, manufacturer, etc.) used in the request URL.

Results Array.<GetVehicleVariableListResults>

The search results returned by the NHSTA API request.

FetchResponse FetchResponse

Fetch API Response properties.

View Source api/actions/GetVehicleVariableList.ts, line 62

object

# GetVehicleVariableListResults

Type representing the structure of objects found in the 'GetVehicleVariableListResponse.Results' array.

Properties:
Name Type Description
DataType string
Description string
ID number
Name string

View Source api/actions/GetVehicleVariableList.ts, line 51