The root element <batch_route_request>
has a number of attributes, most of them optional. The attributes are defined in this section.
The <batch_route_request>
element shares a number of attributes with the <route_request>
element. These attributes share the same meaning as their counterpart <route_request>
attributes, which are explained in batch_route_request Attributes. In addition, the sort_by_distance
and cutoff_distance
attributes do not apply to single route requests.
sort_by_distance
is an optional attribute that specifies whether you want the routes returned in ascending order by distance of the end ___location from the start ___location. TRUE
sorts the returned routes by distance; FALSE
(the default) does not sort the returned routes by distance.
cutoff_distance
is an optional attribute that causes routes to be returned only where the end ___location is less than or equal to a specified distance from the start ___location. By default, all routes are returned.
Note:
If any route is within the batch generates a <router_error>
element in the response (see Batch Route Response XML Schema), the route is removed from the response and not shown.