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

Class

GetParts

api/actions/GetParts.GetParts(userConfigopt)

Implemented by NHTSA.

Extends api/Fetch.Fetch.

Constructor

# new GetParts(userConfigopt)

Parameters:
Name Type Attributes Description
userConfig FetchConfig <optional>

User configuration options to construct the class with.

View Source api/actions/GetParts.ts, line 27

Methods

# async GetParts(paramsopt) → {Promise.<GetPartsResponse>}

This provides a list of ORGs with letter date in the given range of the dates and with specified Type (params.type) of ORG.

  • Up to 1000 results will be returned at a time.
  • Get the next page by incrementing the params.page query parameter.
  • All query params are optional.
Parameters:
Name Type Attributes Description
params object <optional>

Query Search Parameters to append to the URL.

type number <optional>

Specified type of ORG to search.

fromDate string <optional>

Start date of search query.

toDate string <optional>

End date of search query.

page number <optional>

Which page number of results to request (100 results per page).

View Source api/actions/GetParts.ts, line 46

Api Response object.

Promise.<GetPartsResponse>