RouteDirectionsResponse interface

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Package:

azure-maps-rest

This object is returned from a successful Route Directions call

Properties

copyright	Copyright property NOTE: This property will not be serialized. It can only be populated by the server.
formatVersion	Format Version property NOTE: This property will not be serialized. It can only be populated by the server.
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". NOTE: This property will not be serialized. It can only be populated by the server.
privacy	Privacy property NOTE: This property will not be serialized. It can only be populated by the server.
report
routes	Routes array NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

copyright

Copyright property NOTE: This property will not be serialized. It can only be populated by the server.

copyright?: string

Property Value

string

formatVersion

Format Version property NOTE: This property will not be serialized. It can only be populated by the server.

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". NOTE: This property will not be serialized. It can only be populated by the server.

optimizedWaypoints?: RouteOptimizedWaypoint[]

Property Value

RouteOptimizedWaypoint[]

privacy

Privacy property NOTE: This property will not be serialized. It can only be populated by the server.

privacy?: string

Property Value

string

report

report?: RouteResponseReport

Property Value

RouteResponseReport

routes

Routes array NOTE: This property will not be serialized. It can only be populated by the server.

routes?: RouteDirectionsResult[]

Property Value

RouteDirectionsResult[]