Share via

GetRouteDirections interface

  • Reference
Package:
@azure-rest/maps-route

Methods

get(RouteGetRouteDirectionsParameters)

The Get Route Directions API is an HTTP GET request that returns a route between an origin and a destination, passing through waypoints if specified. The route takes into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.

Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.

Routing service provides a set of parameters for a detailed description of a vehicle-specific consumption model. For more information, see Consumption Model.
post(RouteGetRouteDirectionsWithAdditionalParametersParameters)

The Post Route Directions API is an HTTP POST request that returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.

Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.

Routing service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check Consumption Model for detailed explanation of the concepts and parameters involved.

Method Details

get(RouteGetRouteDirectionsParameters)

The Get Route Directions API is an HTTP GET request that returns a route between an origin and a destination, passing through waypoints if specified. The route takes into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.

Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.

Routing service provides a set of parameters for a detailed description of a vehicle-specific consumption model. For more information, see Consumption Model.

function get(options: RouteGetRouteDirectionsParameters): StreamableMethod<RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse>

Parameters

options
RouteGetRouteDirectionsParameters

Returns

StreamableMethod<RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse>

post(RouteGetRouteDirectionsWithAdditionalParametersParameters)

The Post Route Directions API is an HTTP POST request that returns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.

Information returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.

Routing service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check Consumption Model for detailed explanation of the concepts and parameters involved.

function post(options: RouteGetRouteDirectionsWithAdditionalParametersParameters): StreamableMethod<RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse>

Parameters

options
RouteGetRouteDirectionsWithAdditionalParametersParameters

Returns

StreamableMethod<RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse>