Skip to content

CalculateRouteMatrixResponse

Source code in docs_src/capo_geo_routes/types/calculate_route_matrix_response.py 
14
15
16
17
18
19
20
21
22
class CalculateRouteMatrixResponse(TypedDict, closed=True):
    error_count: "int"
    """<p>The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.</p>"""
    pricing_bucket: "str"
    """<p>The pricing bucket for which the query is charged at.</p>"""
    route_matrix: "capo_geo_routes.types.route_matrix.RouteMatrix"
    """<p>The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.</p>"""
    routing_boundary: "capo_geo_routes.types.route_matrix_boundary.RouteMatrixBoundary"
    """<p>Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.</p> <note> <p>When <code>AutoCircle</code> is set in the request, the response routing boundary will return <code>Circle</code> derived from the <code>AutoCircle</code> settings.</p> </note>"""

error_count instance-attribute 

error_count: int

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

pricing_bucket instance-attribute 

pricing_bucket: str

The pricing bucket for which the query is charged at.

route_matrix instance-attribute 

route_matrix: RouteMatrix

The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.

routing_boundary instance-attribute 

routing_boundary: RouteMatrixBoundary

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

When AutoCircle is set in the request, the response routing boundary will return Circle derived from the AutoCircle settings.