gbfs-v3/dev.sargunv.mobilitydata.gbfs.v3/VehicleType

VehicleType

data class VehicleType(val vehicleTypeId: String, val formFactor: VehicleFormFactor, val riderCapacity: Int? = null, val cargoVolumeCapacity: Int? = null, val cargoLoadCapacity: Int? = null, val propulsionType: VehiclePropulsionType, val ecoLabels: List<EcoLabel>? = null, val maxRangeMeters: Double? = null, val name: LocalizedText? = null, val vehicleAccessories: List<VehicleAccessory>? = null, val gCO2km: Int? = null, val vehicleImage: Url? = null, val make: LocalizedText? = null, val model: LocalizedText? = null, val color: String? = null, val description: LocalizedText? = null, val wheelCount: Int? = null, val maxPermittedSpeed: Int? = null, val ratedPower: Int? = null, val defaultReserveTime: WholeMinutes? = null, val returnConstraint: VehicleReturnConstraint? = null, val vehicleAssets: VehicleAssets? = null, val defaultPricingPlanId: String? = null, val pricingPlanIds: List<String>? = null)(source)

Information about a vehicle type available in the system.

Constructors

constructor(vehicleTypeId: String, formFactor: VehicleFormFactor, riderCapacity: Int? = null, cargoVolumeCapacity: Int? = null, cargoLoadCapacity: Int? = null, propulsionType: VehiclePropulsionType, ecoLabels: List<EcoLabel>? = null, maxRangeMeters: Double? = null, name: LocalizedText? = null, vehicleAccessories: List<VehicleAccessory>? = null, gCO2km: Int? = null, vehicleImage: Url? = null, make: LocalizedText? = null, model: LocalizedText? = null, color: String? = null, description: LocalizedText? = null, wheelCount: Int? = null, maxPermittedSpeed: Int? = null, ratedPower: Int? = null, defaultReserveTime: WholeMinutes? = null, returnConstraint: VehicleReturnConstraint? = null, vehicleAssets: VehicleAssets? = null, defaultPricingPlanId: String? = null, pricingPlanIds: List<String>? = null)

Properties

cargoLoadCapacity

@SerialName(value = "cargo_load_capacity")

val cargoLoadCapacity: Int?

The capacity of the vehicle cargo space (excluding passengers), expressed in kilograms.

cargoVolumeCapacity

@SerialName(value = "cargo_volume_capacity")

val cargoVolumeCapacity: Int?

Cargo volume available in the vehicle, expressed in liters.

val color: String?

The color of the vehicle, in plain English.

defaultPricingPlanId

@SerialName(value = "default_pricing_plan_id")

val defaultPricingPlanId: String?

A plan_id that identifies a default pricing plan for this vehicle to be used by trip planning applications.

defaultReserveTime

@SerialName(value = "default_reserve_time")

val defaultReserveTime: WholeMinutes?

Maximum time that a vehicle can be reserved before a rental begins.

val description: LocalizedText?

Customer-readable description of the vehicle type outlining special features or how-tos.

@SerialName(value = "eco_labels")

val ecoLabels: List<EcoLabel>?

Vehicle air quality certificate.

@SerialName(value = "form_factor")

val formFactor: VehicleFormFactor

The vehicle's general form factor.

@SerialName(value = "g_CO2_km")

val gCO2km: Int?

Maximum quantity of CO2, in grams, emitted per kilometer, according to the WLTP.

val make: LocalizedText?

The name of the vehicle manufacturer.

maxPermittedSpeed

@SerialName(value = "max_permitted_speed")

val maxPermittedSpeed: Int?

The maximum speed in kilometers per hour this vehicle is permitted to reach in accordance with local permit and regulations.

@SerialName(value = "max_range_meters")

val maxRangeMeters: Double?

The furthest distance in meters that the vehicle can travel without recharging or refueling.

val model: LocalizedText?

The name of the vehicle model.

val name: LocalizedText?

The public name of this vehicle type.

@SerialName(value = "pricing_plan_ids")

val pricingPlanIds: List<String>?

Array of all pricing plan IDs that are applied to this vehicle type.

@SerialName(value = "propulsion_type")

val propulsionType: VehiclePropulsionType

The primary propulsion type of the vehicle.

@SerialName(value = "rated_power")

val ratedPower: Int?

The rated power of the motor for this vehicle type in watts.

returnConstraint

@SerialName(value = "return_constraint")

val returnConstraint: VehicleReturnConstraint?

The conditions for returning the vehicle at the end of the rental.

@SerialName(value = "rider_capacity")

val riderCapacity: Int?

The number of riders (driver included) the vehicle can legally accommodate.

vehicleAccessories

@SerialName(value = "vehicle_accessories")

val vehicleAccessories: List<VehicleAccessory>?

Description of accessories available in the vehicle.

@SerialName(value = "vehicle_assets")

val vehicleAssets: VehicleAssets?

Icon images and metadata for representing this vehicle type.

@SerialName(value = "vehicle_image")

val vehicleImage: Url?

URL to an image that would assist the user in identifying the vehicle.

@SerialName(value = "vehicle_type_id")

val vehicleTypeId: String

Unique identifier of a vehicle type.

@SerialName(value = "wheel_count")

val wheelCount: Int?

Number of wheels this vehicle type has.