@shaggytools/nhtsa-api-wrapper - v3.0.4 / Exports / api/endpoints/GetEquipmentPlantCodes

Module: api/endpoints/GetEquipmentPlantCodes ​

Table of contents ​

Type Aliases ​

• GetEquipmentPlantCodesParams
• GetEquipmentPlantCodesResults

Functions ​

• GetEquipmentPlantCodes

Type Aliases ​

GetEquipmentPlantCodesParams ​

Ƭ GetEquipmentPlantCodesParams: Object

Query String Parameters for this endpoint

Type declaration ​

Defined in ​

api/endpoints/GetEquipmentPlantCodes.ts:105

GetEquipmentPlantCodesResults ​

Ƭ GetEquipmentPlantCodesResults: Object

Objects found in the Results array of GetEquipmentPlantCodes endpoint response.

Type declaration ​

Defined in ​

api/endpoints/GetEquipmentPlantCodes.ts:122

Functions ​

GetEquipmentPlantCodes ​

▸ GetEquipmentPlantCodes(params, doFetch?): Promise<NhtsaResponse<GetEquipmentPlantCodesResults>>

GetEquipmentPlantCodes returns assigned Equipment Plant Codes. Can be filtered by Year, Equipment Type and Report Type.

ALL parameters are required and endpoint will return 404 if there are any undefined keys and/or values in the query string.

params.equipmentType:

• 1 (Tires)
• 3 (Brake Hoses)
• 13 (Glazing)
• 16 (Retread)

params.reportType:

• 'New' (The Equipment Plant Code was assigned during the selected year)
• 'Updated' (The Equipment Plant data was modified during the selected year)
• 'Closed' (The Equipment Plant is no longer Active)
• 'All' (All Equipment Plant Codes regardless of year, including their status (active or closed))

params.year:

• year >= 2016
• NOTE: It seems API will still respond with years < 2016 but api docs state only years >= 2016 are supported

Parameters ​

Returns ​

Promise<NhtsaResponse<GetEquipmentPlantCodesResults>>

• Api Response object -or- url string if doFetch = false

Defined in ​

api/endpoints/GetEquipmentPlantCodes.ts:47

▸ GetEquipmentPlantCodes(params, doFetch): Promise<string>

Parameters ​

Returns ​

Promise<string>

Defined in ​

api/endpoints/GetEquipmentPlantCodes.ts:52