Skip to content

IsolineScooterOptions

Source code in docs_src/capo_geo_routes/types/isoline_scooter_options.py
class IsolineScooterOptions(TypedDict, closed=True):
    engine_type: NotRequired[
        "capo_geo_routes.types.isoline_engine_type.IsolineEngineType"
    ]
    """<p>The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.</p> <ul> <li> <p> <code>INTERNAL_COMBUSTION</code>—Standard gasoline or diesel engine.</p> </li> <li> <p> <code>ELECTRIC</code>—Battery electric vehicle.</p> </li> <li> <p> <code>PLUGIN_HYBRID</code>—Combination of electric and internal combustion engines with plug-in charging capability.</p> </li> </ul>"""
    license_plate: NotRequired[
        "capo_geo_routes.types.isoline_vehicle_license_plate.IsolineVehicleLicensePlate"
    ]
    """<p>License plate information used in regions where road access or routing restrictions are based on license plate numbers.</p>"""
    max_speed: NotRequired[
        "capo_geo_routes.types.speed_kilometers_per_hour.SpeedKilometersPerHour"
    ]
    """<p>The maximum speed of the vehicle in kilometers per hour. When specified, routes will not include roads with higher speed limits. Valid values range from 3.6 km/h (1 m/s) to 252 km/h (70 m/s).</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>"""
    occupancy: NotRequired["capo_geo_routes.types.sensitive_integer.SensitiveInteger"]
    """<p>The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.</p> <p>Default value: <code>1</code> </p>"""

engine_type instance-attribute

engine_type: NotRequired[IsolineEngineType]

The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.

  • INTERNAL_COMBUSTION—Standard gasoline or diesel engine.

  • ELECTRIC—Battery electric vehicle.

  • PLUGIN_HYBRID—Combination of electric and internal combustion engines with plug-in charging capability.

license_plate instance-attribute

license_plate: NotRequired[IsolineVehicleLicensePlate]

License plate information used in regions where road access or routing restrictions are based on license plate numbers.

max_speed instance-attribute

max_speed: NotRequired[SpeedKilometersPerHour]

The maximum speed of the vehicle in kilometers per hour. When specified, routes will not include roads with higher speed limits. Valid values range from 3.6 km/h (1 m/s) to 252 km/h (70 m/s).

Unit: kilometers per hour

occupancy instance-attribute

occupancy: NotRequired[SensitiveInteger]

The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.

Default value: 1