queryType: getVehicleClasses

The getVehicleClasses queryType is passed to the API to get the vehicle class list used in the application.

Parameters

These parameters should be passed to the functionParameters object regardless of which method you choose from here.


Parameter	Description	Type	Defined Value Set	Value Req'd
queryType	Must equal "`getVehicleClasses`".	STRING	"`getVehicleClasses`"	Y
vehicleClassSchemeId	SchemeId that indicates which vehicle classification scheme you will receive data for. See the Data Dictionary for a list of options.	INT	[1,4]	Y


Code	Type	Description
200	JSON	The requested data.
401	JSON	Occurs for various unauthorized tasks, such as not providing credentials in your parameters.
500	JSON	Occurs if an internal server error occurs. Contact altitudesupport@geotab.com if this occurs.


Attribute	Description	Data Type	Defined Value Set
CategoryDescription	Schema description of selected SchemeId.	STRING	See the Vehicle Class Schema table.
CategoryIndex	Number associated with SchemeId.	INTEGER	See the Vehicle Class Schema table.
MaxWeightKilograms	Maximum weight for the vehicle class (measured in kilograms).	INTEGER	-
MaxWeightPounds	Maximum weight for the vehicle class (measured in pounds).	INTEGER	-
MinWeightKilograms	Minimum weight for the vehicle class (measured in kilograms).	INTEGER	-
MinWeightPounds	Minimum weight for the vehicle class (measured in pounds).	INTEGER	-
SchemeId	SchemeId determines for which vehicle classification scheme you will receive data.	INTEGER	See the Vehicle Class Schema table.
VehicleClass	Vehicle class name.	STRING	See the Vehicle Class tableNo Content found for /db/organizations/geotab/repositories/master/content/documents/Altitude_Copy/Data_Dictionary/Platform/Vehicle_filters/Vehicle_class.dita#concept-6348.
VehicleClassIndex	Number representing vehicle class.	INTEGER	0 - Light-Duty Trucks 1 - Medium-Duty Trucks 2 - Heavy-Duty Trucks 3 - Passenger Vehicles 4 - Multi-Purpose Vehicles 5 - Buses 6 - Other Classes
VehicleType	Types of vehicles in that class.	STRING	Truck Limo Bus MPV Passenger Other
WeightClasses	Standard weight class.	ARRAY	See the Vehicle Weight Class table.
WeightClassGrouping	Name of Vehicle Class Schema.	STRING	See the Vehicle Class Schema table.

{
"queryType": "getVehicleClasses",
"vehicleClassSchemeId": 2
}