Routeplanner

This service provides routeplanner methods through which route descriptions, as well as drivetime and drive distance, can be requested.  Information on routes within the Netherlands can be retrieved based on postcodes or RD (Rijksdriehoeksmeting) coordinates.  Routes through Europe can be requested based on latitude/longitude coordinates.

Summary
This service provides routeplanner methods through which route descriptions, as well as drivetime and drive distance, can be requested.
Returns a description of the route calculated between two addresses.
Returns the route distance and driving time between two addresses.
Returns a description of the route calculated between two addresses For every part of the route the drivetime and drivedistance are given.
Returns a description of the fastest route between two dutch postcodes.
Returns a description of the shortest route between two dutch postcodes.
Returns a description of the route between two dutch postcodes, including the RD coordinates along the route.
Returns the route distance and driving time between two dutch postcodes.
Returns a description of the route between two coordinates in the RD (Rijksdriehoeksmeting) coordinate system.
Returns the route distance and drive time between two coordinates in the RD (Rijksdriehoeksmeting) coordinate system.
Returns a description of the route between two coordinates in the RD (Rijksdriehoeksmeting) coordinate system, including the RD coordinates along the route.
Returns the route distance and driving time between two dutch addresses.
Returns a description of the route calculated between two dutch addresses For every part of the route the drivetime and drivedistance are given as well.
Returns a description of the route between two latitude/longitude coordinates in Europe.
Returns the route distance and drive time for the route between two latitude/longitude coordinates in Europe.
Returns a description of the route between two latitude/longitude coordinates in Europe, including the latitude/longitude coordinates along the route.
This method is deprecated, use routePlannerDescription instead
This method is deprecated, use routePlannerInformation instead
This method is deprecated and will be removed
A complete route description which includes the calculated start and end point, the estimated time and distance, route description and the calculated route as image.
The address and coordinate information.
The corrected/complemented input address (used for coordinate lookup).
The coordinates used for start/end point of the route.
These coordinates are part of the Dutch triangulation frame called “Rijksdriehoeksmeting” or RD.
Basic information about the route, like drive time, distance and type of route
A single route planner description entry.
A single route planner information entry.
A route coordinates entry.
A route planner description entry with RD coordinates.
A route coordinates entry.
A route planner description entry with RD coordinates.

International routes

routePlannerGetRoute

Returns a description of the route calculated between two addresses.

Parameters

start_postcodeStart address postcode.
start_house_numberStart address house number.
start_house_number_additionStart address house number addition.
start_streetStart address street.
start_cityStart address city.
start_countryStart address country.
destination_postcodeDestination address postcode.
destination_house_numberDestination address house number.
destination_house_number_additionDestination address house number addition.
destination_streetDestination address street.
destination_cityDestination address city.
destination_countryDestination address country.
route_typeType of route to calculate:
fastestCalculates the fastest route.  (default)
shortestThe shortest possible route.
languageLanguage of the description, currently supports:
danishdanske
englishenglish
frenchfran├žais
germanDeutsch
italianitaliano
dutchnederlands

Returns

routeA RoutePlannerRoute entry.

routePlannerInformationAddress

Returns the route distance and driving time between two addresses.

Parameters

routetypeType of route to calculate, ‘fastest’ or ‘shortest’
from_postalcodeStart address postal code
from_housenoStart address house number
from_streetStart address street
from_cityStart address city
from_countryStart country (ISO3, ISO2 or Full-Text)
to_postalcodeDestination address postal code
to_housenoDestination address house-number
to_streetDestination address street
to_cityDestination address city
to_countryDestination country (ISO3, ISO2 or Full-Text)

Returns

routeA RouteInfo entry.

routePlannerDescriptionAddress

Returns a description of the route calculated between two addresses For every part of the route the drivetime and drivedistance are given.  The description is available in several languages controlled by the language parameter.  The fastest or shortest route can be calculated

Parameters

routetypeType of route to calculate, ‘fastest’ or ‘shortest’
from_postalcodeStart address postal code
from_housenoStart address house number
from_streetStart address street
from_cityStart address city
from_countryStart country (ISO3, ISO2 or Full-Text)
to_postalcodeDestination address postal code
to_housenoDestination address house-number
to_streetDestination address street
to_cityDestination address city
to_countryDestination country (ISO3, ISO2 or Full-Text)
languageLanguage of the description: ‘danish’, ‘dutch’, ‘english’, ‘french’, ‘german’ or ‘italian’

Returns

routeA Patterns::{Type}Array of RoutePart entries.

Routes in the Netherlands

routePlannerDescription

Returns a description of the fastest route between two dutch postcodes.  For every part of the route the drivetime in seconds and drivedistance in meters are given as well.  The description is available in dutch and english, depending on the english parameter toggle.

Parameters

postcodefromPostcode at the start of the route
postcodetoPostcode at the end of the route
englishWhether to returns the description in english (true) or dutch (false)

Returns

routeA Patterns::{Type}Array of RoutePart entries.

routePlannerDescriptionShortest

Returns a description of the shortest route between two dutch postcodes.  For every part of the route the drivetime in seconds and drivedistance in meters are given as well.  The description is available in dutch and english, depending on the english parameter toggle.

Parameters

postcodefromPostcode at the start of the route
postcodetoPostcode at the end of the route
englishWhether to returns the description in english (true) or dutch (false)

Returns

routeA Patterns::{Type}Array of RoutePart entries.

routePlannerDescriptionCoordinatesRD

Returns a description of the route between two dutch postcodes, including the RD coordinates along the route.  For every part of the route the drivetime in seconds and drivedistance in meters are given as well.  The routetype can be shortest or fastest.  By default the fastest route will be calculated.  The description is available in dutch and english, depending on the english parameter toggle.

Parameters

postcodefromPostcode at the start of the route
postcodetoPostcode at the end of the route
routetypeType of route to calculate: ‘fastest’ or ‘shortest’
englishWhether to returns the description in english (true) or dutch (false)

Returns

routeA RouteDescriptionCoordinatesRD entry.

routePlannerInformation

Returns the route distance and driving time between two dutch postcodes.  The routetype can be shortest or fastest.  By default the fastest route will be calculated.  Methods that works on neighborhoodcodes can be found in the Driveinfo service.

Parameters

postcodefromPostcode at the start of the route
postcodetoPostcode at the end of the route
routetypeType of route to calculate: ‘fastest’ or ‘shortest’

Returns

routeA RouteInfo entry.

See also

Driveinfo::driveInfoDistanceLookup, Geolocation::geoLocationPostcodeDistance

routePlannerRDDescription

Returns a description of the route between two coordinates in the RD (Rijksdriehoeksmeting) coordinate system.  For every part of the route the drivetime in seconds and drivedistance in meters are given as well.  The description is available in dutch and english, depending on the english parameter toggle.  The fastest or shortest route can be calculated depending on the routetype parameter.

Parameters

xfromx part of the RD coordinate at the start of the route
yfromy part of the RD coordinate at the start of the route
xtox part of the RD coordinate at the end of the route
ytoy part of the RD coordinate at the end of the route
routetypeType of route to calculate: ‘fastest’ or ‘shortest’
englishWhether to returns the description in english (true) or dutch (false)

Returns

routeA Patterns::{Type}Array of RoutePart entries.

See also

Geolocation::geoLocationRDToPostcode

routePlannerRDInformation

Returns the route distance and drive time between two coordinates in the RD (Rijksdriehoeksmeting) coordinate system.  The fastest or shorted route can be calculated depending on the routetype parameter.  Methods that works on neighborhoodcodes can be found in the Driveinfo service.

Parameters

xfromx part of the RD coordinate at the start of the route
yfromy part of the RD coordinate at the start of the route
xtox part of the RD coordinate at the end of the route
ytoy part of the RD coordinate at the end of the route
routetypeType of route to calculate: ‘fastest’ or ‘shortest’

Returns

routeA RouteInfo entry.

routePlannerRDDescriptionCoordinatesRD

Returns a description of the route between two coordinates in the RD (Rijksdriehoeksmeting) coordinate system, including the RD coordinates along the route.  For every part of the route the drivetime in seconds and drivedistance in meters are given as well.  The fastest or shortest route can be calculated depending on the routetype parameter.  The description is available in dutch and english, depending on the english parameter toggle.

Parameters

xfromx part of the RD coordinate at the start of the route
yfromy part of the RD coordinate at the start of the route
xtox part of the RD coordinate at the end of the route
ytoy part of the RD coordinate at the end of the route
routetypeType of route to calculate: ‘fastest’ or ‘shortest’
englishWhether to returns the description in english (true) or dutch (false)

Returns

routeA RouteDescriptionCoordinatesRD entry.

routePlannerInformationDutchAddress

Returns the route distance and driving time between two dutch addresses.

Parameters

routetypeType of route to calculate, ‘fastest’ or ‘shortest’
from_postalcodeStart address postal code
from_housnoStart address house number
from_streetStart address street
from_cityStart address city
to_postalcodeDestination address postal code
to_housnoDestination address house-number
to_streetDestination address street
to_cityDestination address city

Returns

routeA RouteInfo entry.

routePlannerDescriptionDutchAddress

Returns a description of the route calculated between two dutch addresses For every part of the route the drivetime and drivedistance are given as well.  The description is available in several languages depending on the language parameter.  The fastest or shortest route can be calculated

Parameters

routetypeType of route to calculate, ‘fastest’ or ‘shortest’
from_postalcodeStart address postal code
from_housnoStart address house number
from_streetStart address street
from_cityStart address city
to_postalcodeDestination address postal code
to_housnoDestination address house-number
to_streetDestination address street
to_cityDestination address city
languageLanguage of the description: ‘danish’, ‘dutch’, ‘english’, ‘french’, ‘german’ or ‘italian’

Returns

routeA Patterns::{Type}Array of RoutePart entries.

Routes in Europe

routePlannerEUDescription

Returns a description of the route between two latitude/longitude coordinates in Europe.  For every part of the route the drivetime and drivedistance are given as well.  The description is available in several languages depending on the language parameter.  The fastest or shortest route is calculated depending on the routetype parameter.

Parameters

latitudefromLatitude of the start of the route
longitudefromLongitude of the start of the route
latitudetoLatitude of the end of the route
longitudetoLongitude of the end of the route
routetypeType of route to calculate: ‘fastest’ or ‘shortest’
languageLanguage of the description: ‘danish’, ‘dutch’, ‘english’, ‘french’, ‘german’, ‘italian’ or ‘swedish’

Returns

routeA Patterns::{Type}Array of RoutePart entries.

routePlannerEUInformation

Returns the route distance and drive time for the route between two latitude/longitude coordinates in Europe.  The fastest or shortest route can be calculated depending on the routetype parameter.

Parameters

latitudefromLatitude of the start of the route
longitudefromLongitude of the start of the route
latitudetoLatitude of the end of the route
longitudetoLongitude of the end of the route
routetypeType of route to calculate: ‘fastest’ or ‘shortest’

Returns

routeA RouteInfo entry.

routePlannerEUDescriptionCoordinatesLatLon

Returns a description of the route between two latitude/longitude coordinates in Europe, including the latitude/longitude coordinates along the route.  For every part of the route the drivetime in seconds and drivedistance in meters are given as well.  The routetype can be shortest or fastest.  By default the fastest route will be calculated.  The description is available in several languages depending on the language parameter.

Parameters

latitudefromLatitude of the start of the route
longitudefromLongitude of the start of the route
latitudetoLatitude of the end of the route
longitudetoLongitude of the end of the route
routetypeType of route to calculate: ‘fastest’ or ‘shortest’
languageLanguage of the description: ‘danish’, ‘dutch’, ‘english’, ‘french’, ‘german’, ‘italian’ or ‘swedish’

Returns

routeA RouteDescriptionCoordinatesLatLon entry.

Deprecated service methods

routeDescription

Notice

This method is deprecated, use routePlannerDescription instead

Returns a description of the route between two dutch postcodes.  For every part of the route the drivetime in seconds and drivedistance in meters are given as well.  The description is available in dutch and english, dependent of the english parameter toggle.

Parameters

postcodefromPostcode at the start of the route
postcodetoPostcode at the end of the route
englishWhether to returns the description in english (true) or dutch (false)

Returns

routeA Patterns::{Type}Array of RoutePart entries.

routeInformation

Notice

This method is deprecated, use routePlannerInformation instead

Returns the route distance and driving time between two dutch postcodes.  Either the fastest or shorted route can be calculated depending on the routetype parameter.  Methods that works on neighborhoodcodes can be found in the Driveinfo service.

Parameters

postcodefromPostcode at the start of the route
postcodetoPostcode at the end of the route
routetypeType of route to calculate, ‘fastest’ or ‘shortest’

Returns

routeA RouteInfo entry.

routePlannerEUMap

Notice

This method is deprecated and will be removed

Returns a map showing the route between two latitude/longitude coordinates in Europe.

Parameters

latitudefromLatitude of the start of the route
longitudefromLongitude of the start of the route
latitudetoLatitude of the end of the route
longitudetoLongitude of the end of the route
routetypeType of route to calculate, ‘fastest’ or ‘shortest’
languagePreferred output language ‘danish’, ‘dutch’, ‘english’, ‘french’, ‘german’, ‘italian’ or ‘swedish’
formatImage format.  Supported formats: ‘JPG’, ‘PNG’
widthWidth in pixels, domain [80 - 800]
heightHeight in pixels, domain [80 - 800]
viewWhich part of the route to dispay.  Possible values: ‘start’ (display the starting point), ‘end’ (display the destination), ‘overview’ (display the complete route, default)

Returns

imageA JPEG or PNG image, base64 encoded.

Type definitions

RoutePlannerRoute

A complete route description which includes the calculated start and end point, the estimated time and distance, route description and the calculated route as image.

startA RouteLocation entry.
destinationA RouteLocation entry.
summaryA RouteSummary entry.
descriptionA Patterns::{Type}Array of RoutePart entries.
mapA base64 encoded string containing the route as a “600 x 600 pixel” image in jpeg format, if available.

RouteLocation

The address and coordinate information.

addressA RouteAddress entry.
coordinatesA RouteCoordinates entry.

RouteAddress

The corrected/complemented input address (used for coordinate lookup).

postcodeThe postcode of the address.
house_numberThe house number of the address.
house_number_additionThe house number addition of the address.
streetThe street part of the address.
cityThe city of the address.
countryThe address country
address_keyThe addres identifier, only available for dutch addresses.
The "address_key" can be used to validate an address with one of the functions below.

RouteCoordinates

The coordinates used for start/end point of the route.

latlongA RouteCoordinateLatLong entry, containing the coordinate in latitude and longitude
rdA RouteCoordinateRD entry, only available for dutch address locations.

RouteCoordinateLatLong

latitudeThe latitude of the coordinate.
longitudeThe longitude of the coordinate.

RouteCoordinateRD

These coordinates are part of the Dutch triangulation frame called “Rijksdriehoeksmeting” or RD.

xThe coordinate x.
yThe coordinate y.

Only available for addresses within the Netherlands.

RouteSummary

Basic information about the route, like drive time, distance and type of route

timeThe estimated total time in seconds.
distanceThe estimated distance of the route in meters.
typeThe route type that is used for calculating route, available types:
fastestCalculates the fastest route.  (default)
shortestThe shortest posible route.

RoutePart

A single route planner description entry.

descriptionThe description of this part of the route
timeEstimated time in seconds to travel this part of the route
distanceEstimated distance in meters between the start and ending point of this part of the route

RouteInfo

A single route planner information entry.

timeEstimated time in seconds required to travel the route
distanceEstimated distance in meters required to travel the route

RouteCoordinatesRD

A route coordinates entry.

numberThe number of RD coordinates returned
coordinatesA string containing the RD coordinates along the route.  Coordinates (format: x,y) are separated by semi-colons (;).

RouteDescriptionCoordinatesRD

A route planner description entry with RD coordinates.

routecoordinatesA RouteCoordinatesRD entry
partsA Patterns::{Type}Array of RoutePart entries, describing the route

RouteCoordinatesLatLon

A route coordinates entry.

numberThe number of latitude/longitude coordinates returned
coordinatesA string containing the latitude/longitude coordinates along the route.  Coordinates (format: latitude,longitude) are separated by semi-colons (;).

RouteDescriptionCoordinatesLatLon

A route planner description entry with RD coordinates.

routecoordinatesA RouteCoordinatesLatLon entry
partsA Patterns::{Type}Array of RoutePart entries, describing the route
Returns a description of the fastest route between two dutch postcodes.
Returns the route distance and driving time between two dutch postcodes.
A complete route description which includes the calculated start and end point, the estimated time and distance, route description and the calculated route as image.
A single route planner information entry.
An array of type {Type} entries.
A single route planner description entry.
A route planner description entry with RD coordinates.
This service provides methods to give information about the shortest and fastest route between two neighborhood codes in the Netherlands.
Lookup the driving distance in meters between two neighborhoodcodes for both the fastest and shortest route.
Returns the estimated distance in meters (in a direct line) between two postcodes.
Returns the postcode of the address closest to the specified Rijksdriehoeksmeting coordinate in the Netherlands
A route planner description entry with RD coordinates.
The address and coordinate information.
Basic information about the route, like drive time, distance and type of route
The corrected/complemented input address (used for coordinate lookup).
The coordinates used for start/end point of the route.
Determine if a specific address exists using the unique ‘1234AA12’ postcode + house number format.
Determine if a specific address exists using the unique ‘1234AA12’ postcode + house number format.
These coordinates are part of the Dutch triangulation frame called “Rijksdriehoeksmeting” or RD.
A route coordinates entry.
A route coordinates entry.