Skip to content

CalculateIsolinesResponse

Source code in docs_src/capo_geo_routes/types/calculate_isolines_response.py
class CalculateIsolinesResponse(TypedDict, closed=True):
    arrival_time: NotRequired[
        "capo_geo_routes.types.timestamp_with_timezone_offset.TimestampWithTimezoneOffset"
    ]
    """<p>Time of arrival at the destination, used for traffic calculations. This attribute is returned only if the <code>Destination</code> and <code>ArrivalTime</code> attributes were provided in the request.</p> <p>Time format: <code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> </p> <p>Examples:</p> <p> <code>2020-04-22T17:57:24Z</code> </p> <p> <code>2020-04-22T17:57:24+02:00</code> </p>"""
    departure_time: NotRequired[
        "capo_geo_routes.types.timestamp_with_timezone_offset.TimestampWithTimezoneOffset"
    ]
    """<p>Time of departure from the origin, used for traffic calculations. This attribute is returned when <code>Origin</code> was provided in the request and either a specific departure time was requested (<code>DepartureTime</code>) or <code>DepartNow</code> was set to true.</p> <p>Time format: <code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> </p> <p>Examples:</p> <p> <code>2020-04-22T17:57:24Z</code> </p> <p> <code>2020-04-22T17:57:24+02:00</code> </p>"""
    isoline_geometry_format: "capo_geo_routes.types.geometry_format.GeometryFormat"
    """<p>The format of the returned geometries, matching the format specified in the request. Either <code> FlexiblePolyline</code> for compact encoding or <code>Simple</code> for GeoJSON-compatible coordinates.</p> <p>Default value:<code>FlexiblePolyline</code> </p>"""
    isolines: "capo_geo_routes.types.isoline_list.IsolineList"
    """<p>Reachable areas, or isolines, for each threshold specified in the request.</p>"""
    pricing_bucket: "str"
    """<p>The pricing bucket applied to this calculation. Different buckets apply based on the travel mode and thresholds used.</p>"""
    snapped_destination: NotRequired["capo_geo_routes.types.position.Position"]
    """<p>The actual point on the road network used for calculations, which may differ from the requested destination if <code>Destination</code> was not directly on a road.</p>"""
    snapped_origin: NotRequired["capo_geo_routes.types.position.Position"]
    """<p>The actual point on the road network used for calculations, which may differ from the requested origin if <code>Origin</code> was not directly on a road.</p>"""

arrival_time instance-attribute

arrival_time: NotRequired[TimestampWithTimezoneOffset]

Time of arrival at the destination, used for traffic calculations. This attribute is returned only if the Destination and ArrivalTime attributes were provided in the request.

Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

departure_time instance-attribute

departure_time: NotRequired[TimestampWithTimezoneOffset]

Time of departure from the origin, used for traffic calculations. This attribute is returned when Origin was provided in the request and either a specific departure time was requested (DepartureTime) or DepartNow was set to true.

Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

isoline_geometry_format instance-attribute

isoline_geometry_format: GeometryFormat

The format of the returned geometries, matching the format specified in the request. Either FlexiblePolyline for compact encoding or Simple for GeoJSON-compatible coordinates.

Default value:FlexiblePolyline

isolines instance-attribute

isolines: IsolineList

Reachable areas, or isolines, for each threshold specified in the request.

pricing_bucket instance-attribute

pricing_bucket: str

The pricing bucket applied to this calculation. Different buckets apply based on the travel mode and thresholds used.

snapped_destination instance-attribute

snapped_destination: NotRequired[Position]

The actual point on the road network used for calculations, which may differ from the requested destination if Destination was not directly on a road.

snapped_origin instance-attribute

snapped_origin: NotRequired[Position]

The actual point on the road network used for calculations, which may differ from the requested origin if Origin was not directly on a road.