13.3.2.1 route_request Element

The <route_request> element has the following definition:

<xsd:element name="route_request" type="routeRequest" />

The root element of a route request is always named route_request.

The <start_location> child element specifies the start ___location for the route, as an address specification, a geocoded address, or longitude/latitude coordinates. Depending on the route request, there can be 0 or 1 <start_location> elements. A simple route request requires a <start_location> element, whereas an open tour TSP request does not.

The <___location> child element specifies a ___location for a segment, as an address specification, a geocoded address, or longitude/latitude coordinates. In a simple route request there are no <___location> elements; if there are one or more <___location> elements, it is a multi-address route.

The <end_location> child element specifies the end ___location for the route, as an address specification, a geocoded address, or longitude/latitude coordinates. Depending on the route request, there can be 0 or 1 <end_location> elements. A simple route request requires an <end_location> element, whereas a closed tour multi-address or TSP tour must not contain an <end_location> element.

In a route request:

  • If <start_location> is an address specification or longitude/latitude coordinates, each <end_location> and <___location> element can be either an address specification or longitude/latitude coordinate; however, it cannot be a pre-geocoded address.

  • If <start_location> is a pre-geocoded address, <end_location> and any <___location> specifications must also be pre-geocoded addresses.

In a batched route request, each of the individual route requests must follow the preceding rules. However, within the batch, because the individual requests are independent, you can mix address, pre-geocoded, and longitude/latitude locations, as long as they are consistent within an individual request.