Share via

RouteDirectionsBatchItemResponse Class

  • Reference

Definition

Namespace:
Azure.Maps.Routing.Models
Assembly:
Azure.Maps.Routing.dll
Package:
Azure.Maps.Routing v1.0.0-beta.3
Source:
RouteDirectionsBatchItemResponse.cs

The result of the query. RouteDirections if the query completed successfully, ErrorResponse otherwise.

public class RouteDirectionsBatchItemResponse : Azure.Maps.Routing.Models.RouteDirections
type RouteDirectionsBatchItemResponse = class
    inherit RouteDirections
Public Class RouteDirectionsBatchItemResponse
Inherits RouteDirections
Inheritance
Object
RouteDirections
RouteDirectionsBatchItemResponse

Properties

FormatVersion

Format Version property.

(Inherited from RouteDirections)
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".

(Inherited from RouteDirections)
Report

Reports the effective settings used in the current call.

(Inherited from RouteDirections)
ResponseError

The response error.
Routes

Routes array.

(Inherited from RouteDirections)

Applies to