Share via

RouteDirectionsOutput interface

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

This object is returned from a successful Route Directions call

Properties

formatVersion

Format Version property
optimizedWaypoints

Optimized sequence of waypoints. It shows the index from the user provided waypoint sequence for the original and optimized list. For instance, a response:

<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>

means that the original sequence is [0, 1, 2] and optimized sequence is [1, 2, 0]. Since the index starts by 0 the original is "first, second, third" while the optimized is "second, third, first".
report

Reports the effective settings used in the current call.
routes

Routes array

Property Details

formatVersion

Format Version property

formatVersion?: string

Property Value

string

optimizedWaypoints

Optimized sequence of waypoints. It shows the index from the user provided waypoint sequence for the original and optimized list. For instance, a response:

<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>

means that the original sequence is [0, 1, 2] and optimized sequence is [1, 2, 0]. Since the index starts by 0 the original is "first, second, third" while the optimized is "second, third, first".

optimizedWaypoints?: RouteOptimizedWaypointOutput[]

Property Value

RouteOptimizedWaypointOutput[]

report

Reports the effective settings used in the current call.

report?: RouteReportOutput

Property Value

RouteReportOutput

routes

Routes array

routes: RouteOutput[]

Property Value

RouteOutput[]