REST APIs

GeoAnalytics Builder account required

Itinerary

itinerary.{xml | json}

This service loads an itinerary between two points.


An itinerary request requires the parameters start and end which hold the geographic coordinates of the starting and ending points of the required itinerary. The output contains all the coordinates need for drawing the polyline between the two points on a map including the segment for each route action and the summary. An itinerary request must be formatted as follow:

https://geowebservices.maporama.com/itinerary.output?maporamakey=key&parameters

Where:

  • key: Your account key
  • output: The response format. May be either of the following values:
    • .json output in JavaScript Object Notation (JSON)
    • .xml output as XML
The service is available using HTTPS protocol. The HTTPS verb must be GET or POST.

List of parameters

Name Type Values Description
start string e.g. 2.399086;48.717017 The longitude and the latitude of the starting point, separated by semicolon. This is a mandatory field.
end string e.g. 2.260727;49.095227 The longitude and the latitude of the ending point, separated by semicolon. This is a mandatory field.
steps string e.g. 2.2633;49.0989|2.2693;49.1989 A collection of steps in longitude and the latitude , separated by semicolon and pipe for each points.{longitude1};{latitude1}|{longitude2};{latitude2}|..
mode string vehicle | pedestrian The travel mode used for computing the itinerary
language string e.g. EN The language of the itinerary instructions
unitsystem string metricandimperial | metric | imperial The unit system(s) use for the result
avoidtollroad boolean true | false Avoid toll roads
avoidhighways boolean true | false Avoid highways
polyline boolean true | false Return or not the polyline in the result. Default is true
Demo
URL:
Format:
Send request

Example

Definitions

  • Polyline The coordinates of each point used for drawing the itinerary polyline on the map
  • Segments Contains all the segments (route actions) of the itinerary with their name, number in the list, distance and time remaining to the that segment.
  • Summary The summary (main info) of the itinerary: total distance of the route and total time.