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

Module

api/actions/GetEquipmentPlantCodes

GetEquipmentPlantCodes NHSTA Api Action.

Module Exports:

Types

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

Classes

GetEquipmentPlantCodes

Type Definitions

object

# GetEquipmentPlantCodesResponse

Type representing the complete response returned by the GetEquipmentPlantCodes 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.<GetEquipmentPlantCodesResults>

The search results returned by the NHSTA API request.

FetchResponse FetchResponse

Fetch API Response properties.

View Source api/actions/GetEquipmentPlantCodes.ts, line 109

object

# GetEquipmentPlantCodesResults

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

Properties:
Name Type Description
Address string
City string
Country string
DOTCode string
Name string
OldDotCode string
PostalCode string
StateProvince string
Status string

View Source api/actions/GetEquipmentPlantCodes.ts, line 93