RouteVehicleSpan ¶

class RouteVehicleSpan(TypedDict, closed=True):
    best_case_duration: "capo_geo_routes.types.duration_seconds.DurationSeconds"
    """<p>Duration of the computed span without traffic congestion.</p> <p> <b>Unit</b>: <code>seconds</code> </p>"""
    car_access: NotRequired[
        "capo_geo_routes.types.route_span_car_access_attribute_list.RouteSpanCarAccessAttributeList"
    ]
    """<p>Access attributes for a car corresponding to the span.</p>"""
    country: NotRequired["capo_geo_routes.types.country_code3.CountryCode3"]
    """<p>3 letter Country code corresponding to the Span.</p>"""
    distance: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p>Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.</p>"""
    duration: "capo_geo_routes.types.duration_seconds.DurationSeconds"
    """<p>Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.</p> <p> <b>Unit</b>: <code>seconds</code> </p>"""
    dynamic_speed: NotRequired[
        "capo_geo_routes.types.route_span_dynamic_speed_details.RouteSpanDynamicSpeedDetails"
    ]
    """<p>Dynamic speed details corresponding to the span.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>"""
    functional_classification: NotRequired[
        "capo_geo_routes.types.sensitive_integer.SensitiveInteger"
    ]
    """<p>A numerical value indicating the functional classification of the road segment corresponding to the span.</p> <p>Classification values are part of the hierarchical network that helps determine a logical and efficient route, and have the following definitions:</p> <ol> <li> <p>Roads that allow for high volume, maximum speed traffic movement between and through major metropolitan areas.</p> </li> <li> <p>Roads that are used to channel traffic to functional class 1 roads for travel between and through cities in the shortest amount of time.</p> </li> <li> <p>Roads that intersect functional class 2 roads and provide a high volume of traffic movement at a lower level of mobility than functional class 2 roads.</p> </li> <li> <p>Roads that provide for a high volume of traffic movement at moderate speeds between neighborhoods.</p> </li> <li> <p>Roads with volume and traffic movement below the level of any other functional class.</p> </li> </ol>"""
    gate: NotRequired[
        "capo_geo_routes.types.route_span_gate_attribute.RouteSpanGateAttribute"
    ]
    """<p>Attributes corresponding to a gate. The gate is present at the end of the returned span.</p>"""
    geometry_offset: NotRequired["int"]
    """<p>Offset in the leg geometry corresponding to the start of this span.</p>"""
    incidents: NotRequired["capo_geo_routes.types.index_list.IndexList"]
    """<p>Incidents corresponding to the span. These index into the Incidents in the parent Leg.</p>"""
    names: NotRequired[
        "capo_geo_routes.types.localized_string_list.LocalizedStringList"
    ]
    """<p>Provides an array of names of the vehicle span in available languages.</p>"""
    notices: NotRequired["capo_geo_routes.types.index_list.IndexList"]
    """<p>Notices are additional information returned that indicate issues that occurred during route calculation.</p>"""
    railway_crossing: NotRequired[
        "capo_geo_routes.types.route_span_railway_crossing_attribute.RouteSpanRailwayCrossingAttribute"
    ]
    """<p>Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.</p>"""
    region: NotRequired["capo_geo_routes.types.sensitive_string.SensitiveString"]
    """<p>2-3 letter Region code corresponding to the Span. This is either a province or a state.</p>"""
    road_attributes: NotRequired[
        "capo_geo_routes.types.route_span_road_attribute_list.RouteSpanRoadAttributeList"
    ]
    """<p>Attributes for the road segment corresponding to the span. </p>"""
    route_numbers: NotRequired[
        "capo_geo_routes.types.route_number_list.RouteNumberList"
    ]
    """<p>Designated route name or number corresponding to the span.</p>"""
    scooter_access: NotRequired[
        "capo_geo_routes.types.route_span_scooter_access_attribute_list.RouteSpanScooterAccessAttributeList"
    ]
    """<p>Access attributes for a scooter corresponding to the span.</p>"""
    speed_limit: NotRequired[
        "capo_geo_routes.types.route_span_speed_limit_details.RouteSpanSpeedLimitDetails"
    ]
    """<p>Speed limit details corresponding to the span.</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>"""
    toll_systems: NotRequired["capo_geo_routes.types.index_list.IndexList"]
    """<p>Toll systems are authorities that collect payments for the toll.</p>"""
    truck_access: NotRequired[
        "capo_geo_routes.types.route_span_truck_access_attribute_list.RouteSpanTruckAccessAttributeList"
    ]
    """<p>Access attributes for a truck corresponding to the span.</p>"""
    truck_road_types: NotRequired["capo_geo_routes.types.index_list.IndexList"]
    """<p>Truck road type identifiers. <code>BK1</code> through <code>BK4</code> apply only to Sweden. <code>A2,A4,B2,B4,C,D,ET2,ET4</code> apply only to Mexico.</p> <note> <p>There are currently no other supported values as of 26th April 2024.</p> </note>"""
    typical_duration: "capo_geo_routes.types.duration_seconds.DurationSeconds"
    """<p>Duration of the computed span under typical traffic congestion. </p> <p> <b>Unit</b>: <code>seconds</code> </p>"""
    zones: NotRequired["capo_geo_routes.types.index_list.IndexList"]
    """<p>Zones corresponding to this leg of the route.</p>"""