Constructor
# new GetEquipmentPlantCodes(userConfigopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
userConfig |
FetchConfig |
<optional> |
User configuration options to construct the class with. |
Methods
# async GetEquipmentPlantCodes(params) → {Promise.<GetEquipmentPlantCodesResponse>}
Returns assigned Equipment Plant Codes. Can be filtered by Year, Equipment Type and Report Type.
params.year:
- Only years >= 2016 are supported
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)).
Parameters:
| Name | Type | Description |
|---|---|---|
params |
object | Query Search Parameters to append to the URL. |
year |
number | Model year of the vehicle - Number, >= 2016. |
equipmentType |
number | Number equal to 1, 3, 13, or 16. |
reportType |
string | 'New', 'Updated', 'Closed', or 'All'. |
Api Response object.
Promise.<GetEquipmentPlantCodesResponse>