Constructor
# new GetAllManufacturers(userConfigopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
userConfig |
FetchConfig |
<optional> |
User configuration options to construct the class with. |
Methods
# async GetAllManufacturers(paramsopt) → {Promise.<module:api.ApiResponse>}
This provides a list of all the Manufacturers available in vPIC Dataset.
params.manufacturerTypeallows the user to filter the list based on manufacturer type, ('Incomplete Vehicles', 'Completed Vehicle Manufacturer', 'Incomplete Vehicle Manufacturer', 'Intermediate Manufacturer', 'Final-Stage Manufacturer', 'Alterer', or any partial match of those strings).- You can get a list of all manufacturer types with the following API Action:
GetVehicleVariableValuesList('manufacturer type') - Results are provided in pages of 100 items.
- Provide a number value for
params.pageto specify 1st (default), 2nd, 3rd, Nth, etc page.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
params |
object |
<optional> |
{} | Query Search Parameters to append to the URL. |
manufacturerType |
string |
<optional> |
See method description. |
|
page |
number |
<optional> |
Specify the page number (results returned 100 at a time). |
Api Response object.
Promise.<module:api.ApiResponse>