Skip to content

SnapToRoadsRequest

Source code in docs_src/capo_geo_routes/types/snap_to_roads_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class SnapToRoadsRequest(TypedDict, closed=True):
    key: NotRequired["capo_geo_routes.types.api_key.ApiKey"]
    """<p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request. </p>"""
    snapped_geometry_format: NotRequired[
        "capo_geo_routes.types.geometry_format.GeometryFormat"
    ]
    """<p>Chooses what the returned SnappedGeometry format should be.</p> <p>Default value: <code>FlexiblePolyline</code> </p>"""
    snap_radius: "capo_geo_routes.types.distance_meters.DistanceMeters"
    """<p>The radius around the provided tracepoint that is considered for snapping.</p> <p> <b>Unit</b>: <code>meters</code> </p> <p>Default value: <code>300</code> </p>"""
    trace_points: (
        "capo_geo_routes.types.road_snap_trace_point_list.RoadSnapTracePointList"
    )
    """<p>List of trace points to be snapped onto the road network.</p>"""
    travel_mode: NotRequired[
        "capo_geo_routes.types.road_snap_travel_mode.RoadSnapTravelMode"
    ]
    """<p>Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.</p> <p>Default value: <code>Car</code> </p>"""
    travel_mode_options: NotRequired[
        "capo_geo_routes.types.road_snap_travel_mode_options.RoadSnapTravelModeOptions"
    ]
    """<p>Travel mode related options for the provided travel mode.</p>"""

key instance-attribute 

key: NotRequired[ApiKey]

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

snap_radius instance-attribute 

snap_radius: DistanceMeters

The radius around the provided tracepoint that is considered for snapping.

Unit: meters

Default value: 300

snapped_geometry_format instance-attribute 

snapped_geometry_format: NotRequired[GeometryFormat]

Chooses what the returned SnappedGeometry format should be.

Default value: FlexiblePolyline

trace_points instance-attribute 

trace_points: RoadSnapTracePointList

List of trace points to be snapped onto the road network.

travel_mode instance-attribute 

travel_mode: NotRequired[RoadSnapTravelMode]

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default value: Car

travel_mode_options instance-attribute 

travel_mode_options: NotRequired[RoadSnapTravelModeOptions]

Travel mode related options for the provided travel mode.