Skip to content

RouteViolatedConstraints

Source code in docs_src/capo_geo_routes/types/route_violated_constraints.py
class RouteViolatedConstraints(TypedDict, closed=True):
    all_hazards_restricted: NotRequired[
        "capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p>This restriction applies to truck cargo, where the resulting route excludes roads on which hazardous materials are prohibited from being transported.</p>"""
    axle_count: NotRequired[
        "capo_geo_routes.types.route_notice_detail_range.RouteNoticeDetailRange"
    ]
    """<p>Total number of axles of the vehicle.</p>"""
    hazardous_cargos: "capo_geo_routes.types.route_hazardous_cargo_type_list.RouteHazardousCargoTypeList"
    """<p>List of Hazardous cargo contained in the vehicle.</p>"""
    max_height: "capo_geo_routes.types.dimension_centimeters.DimensionCentimeters"
    """<p>The maximum height of the vehicle.</p>"""
    max_kpra_length: "capo_geo_routes.types.dimension_centimeters.DimensionCentimeters"
    """<p>The maximum Kpra length of the vehicle.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>"""
    max_length: "capo_geo_routes.types.dimension_centimeters.DimensionCentimeters"
    """<p>The maximum length of the vehicle.</p>"""
    max_payload_capacity: "capo_geo_routes.types.weight_kilograms.WeightKilograms"
    """<p>The maximum load capacity of the vehicle.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>"""
    max_weight: NotRequired[
        "capo_geo_routes.types.route_weight_constraint.RouteWeightConstraint"
    ]
    """<p>The maximum weight of the route.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>"""
    max_weight_per_axle: "capo_geo_routes.types.weight_kilograms.WeightKilograms"
    """<p>The maximum weight per axle of the vehicle.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>"""
    max_weight_per_axle_group: NotRequired[
        "capo_geo_routes.types.weight_per_axle_group.WeightPerAxleGroup"
    ]
    """<p>The maximum weight per axle group of the vehicle.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>"""
    max_width: "capo_geo_routes.types.dimension_centimeters.DimensionCentimeters"
    """<p>The maximum width of the vehicle.</p>"""
    occupancy: NotRequired[
        "capo_geo_routes.types.route_notice_detail_range.RouteNoticeDetailRange"
    ]
    """<p>The number of occupants in the vehicle.</p> <p>Default value: <code>1</code> </p>"""
    restricted_times: NotRequired["str"]
    """<p>Access radius restrictions based on time.</p>"""
    time_dependent: NotRequired[
        "capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"
    ]
    """<p>The time dependent constraint.</p>"""
    trailer_count: NotRequired[
        "capo_geo_routes.types.route_notice_detail_range.RouteNoticeDetailRange"
    ]
    """<p>Number of trailers attached to the vehicle.</p> <p>Default value: <code>0</code> </p>"""
    travel_mode: NotRequired["capo_geo_routes.types.sensitive_boolean.SensitiveBoolean"]
    """<p>Travel mode corresponding to the leg.</p>"""
    truck_road_type: NotRequired["str"]
    """<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>"""
    truck_type: NotRequired["capo_geo_routes.types.route_truck_type.RouteTruckType"]
    """<p>The type of truck: <code>LightTruck</code> for smaller delivery vehicles, <code> StraightTruck</code> for rigid body trucks, or <code>Tractor</code> for tractor-trailer combinations.</p>"""
    tunnel_restriction_code: NotRequired[
        "capo_geo_routes.types.tunnel_restriction_code.TunnelRestrictionCode"
    ]
    """<p>The tunnel restriction code.</p> <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.</p> <ul> <li> <p> <i>Tunnel Category B</i> </p> <ul> <li> <p> <i>Risk Level</i>: Limited risk</p> </li> <li> <p> <i>Restrictions</i>: Few restrictions</p> </li> </ul> </li> <li> <p> <i>Tunnel Category C</i> </p> <ul> <li> <p> <i>Risk Level</i>: Medium risk</p> </li> <li> <p> <i>Restrictions</i>: Some restrictions</p> </li> </ul> </li> <li> <p> <i>Tunnel Category D</i> </p> <ul> <li> <p> <i>Risk Level</i>: High risk</p> </li> <li> <p> <i>Restrictions</i>: Many restrictions occur</p> </li> </ul> </li> <li> <p> <i>Tunnel Category E</i> </p> <ul> <li> <p> <i>Risk Level</i>: Very high risk</p> </li> <li> <p> <i>Restrictions</i>: Restricted tunnel</p> </li> </ul> </li> </ul>"""

all_hazards_restricted instance-attribute

all_hazards_restricted: NotRequired[SensitiveBoolean]

This restriction applies to truck cargo, where the resulting route excludes roads on which hazardous materials are prohibited from being transported.

axle_count instance-attribute

axle_count: NotRequired[RouteNoticeDetailRange]

Total number of axles of the vehicle.

hazardous_cargos instance-attribute

hazardous_cargos: RouteHazardousCargoTypeList

List of Hazardous cargo contained in the vehicle.

max_height instance-attribute

The maximum height of the vehicle.

max_kpra_length instance-attribute

max_kpra_length: DimensionCentimeters

The maximum Kpra length of the vehicle.

Unit: centimeters

max_length instance-attribute

The maximum length of the vehicle.

max_payload_capacity instance-attribute

max_payload_capacity: WeightKilograms

The maximum load capacity of the vehicle.

Unit: kilograms

max_weight instance-attribute

max_weight: NotRequired[RouteWeightConstraint]

The maximum weight of the route.

Unit: kilograms

max_weight_per_axle instance-attribute

max_weight_per_axle: WeightKilograms

The maximum weight per axle of the vehicle.

Unit: kilograms

max_weight_per_axle_group instance-attribute

max_weight_per_axle_group: NotRequired[WeightPerAxleGroup]

The maximum weight per axle group of the vehicle.

Unit: kilograms

max_width instance-attribute

The maximum width of the vehicle.

occupancy instance-attribute

occupancy: NotRequired[RouteNoticeDetailRange]

The number of occupants in the vehicle.

Default value: 1

restricted_times instance-attribute

restricted_times: NotRequired[str]

Access radius restrictions based on time.

time_dependent instance-attribute

time_dependent: NotRequired[SensitiveBoolean]

The time dependent constraint.

trailer_count instance-attribute

trailer_count: NotRequired[RouteNoticeDetailRange]

Number of trailers attached to the vehicle.

Default value: 0

travel_mode instance-attribute

travel_mode: NotRequired[SensitiveBoolean]

Travel mode corresponding to the leg.

truck_road_type instance-attribute

truck_road_type: NotRequired[str]

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

truck_type instance-attribute

truck_type: NotRequired[RouteTruckType]

The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.

tunnel_restriction_code instance-attribute

tunnel_restriction_code: NotRequired[TunnelRestrictionCode]

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

  • Tunnel Category B

    • Risk Level: Limited risk

    • Restrictions: Few restrictions

  • Tunnel Category C

    • Risk Level: Medium risk

    • Restrictions: Some restrictions

  • Tunnel Category D

    • Risk Level: High risk

    • Restrictions: Many restrictions occur

  • Tunnel Category E

    • Risk Level: Very high risk

    • Restrictions: Restricted tunnel