Skip to content

SnapToRoadsResponse

Source code in docs_src/capo_geo_routes/types/snap_to_roads_response.py
class SnapToRoadsResponse(TypedDict, closed=True):
    notices: "capo_geo_routes.types.road_snap_notice_list.RoadSnapNoticeList"
    """<p>Notices are additional information returned that indicate issues that occurred during route calculation.</p>"""
    pricing_bucket: "str"
    """<p>The pricing bucket for which the query is charged at.</p>"""
    snapped_geometry: NotRequired[
        "capo_geo_routes.types.road_snap_snapped_geometry.RoadSnapSnappedGeometry"
    ]
    """<p>The interpolated geometry for the snapped route onto the road network.</p>"""
    snapped_geometry_format: "capo_geo_routes.types.geometry_format.GeometryFormat"
    """<p>Specifies the format of the geometry returned for each leg of the route.</p>"""
    snapped_trace_points: "capo_geo_routes.types.road_snap_snapped_trace_point_list.RoadSnapSnappedTracePointList"
    """<p>The trace points snapped onto the road network. </p>"""

notices instance-attribute

Notices are additional information returned that indicate issues that occurred during route calculation.

pricing_bucket instance-attribute

pricing_bucket: str

The pricing bucket for which the query is charged at.

snapped_geometry instance-attribute

snapped_geometry: NotRequired[RoadSnapSnappedGeometry]

The interpolated geometry for the snapped route onto the road network.

snapped_geometry_format instance-attribute

snapped_geometry_format: GeometryFormat

Specifies the format of the geometry returned for each leg of the route.

snapped_trace_points instance-attribute

snapped_trace_points: RoadSnapSnappedTracePointList

The trace points snapped onto the road network.