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.

ParameterDescriptionTypeDefined Value SetValue Req'd
queryTypeMust equal "getVehicleClasses".STRING"getVehicleClasses"Y
vehicleClassSchemeIdDetermines which vehicle classification scheme you will receive data for. See the Vehicle class schemas for a list of options. The default value is 2.INTEGER[1,4]N

Responses

CodeTypeDescription
200JSONThe requested data.
401JSONOccurs for various unauthorized tasks, such as not providing credentials in your parameters.
500JSONOccurs if an internal server error occurs. Contact altitudesupport@geotab.com if this occurs.

Response Schema

AttributeDescriptionData TypeDefined Value Set
CategoryDescriptionSchema description of selected SchemeId.STRINGSee Vehicle class schemas.
CategoryIndexNumber associated with SchemeId.INTEGERSee Vehicle class schemas.
MaxWeightKilogramsMaximum weight for the vehicle class (measured in kilograms).INTEGER-
MaxWeightPoundsMaximum weight for the vehicle class (measured in pounds).INTEGER-
MinWeightKilogramsMinimum weight for the vehicle class (measured in kilograms).INTEGER-
MinWeightPoundsMinimum weight for the vehicle class (measured in pounds).INTEGER-
SchemeIdSchemeId determines for which vehicle classification scheme you will receive data.INTEGERSee Vehicle class schemas.
VehicleClassVehicle class name.STRINGSee Vehicle class schemas.
VehicleClassIndexNumber 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
VehicleTypeTypes of vehicles in that class.STRING
  • Truck
  • Limo
  • Bus
  • MPV
  • Passenger
  • Other
WeightClassesStandard weight class.ARRAYSee Weight class.
WeightClassGroupingName of Vehicle Class Schema.STRINGSee Vehicle class schemas.

Sample parameters

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