Routeplanner

This service provides routeplanner methods through which route descriptions, as well as drivetime and drivedistance, 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 drivedistance, can be requested.
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 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.
Returns a map showing the route between two latitude/longitude coordinates in Europe.
This method is deprecated, use routePlannerDescription instead
This method is deprecated, use routePlannerInformation instead
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.

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.  This function gets its data from an external server.

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.  This function gets its data from an external server.

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 information on the fastest route will be returned.  The description is available in dutch and english, depending on the english parameter toggle.  This function gets its data from an external server.

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.  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.  This function gets its data from an external server.

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.  Either the fastest or shorted route can be calculated depending on the routetype parameter.  This function gets its data from an external server.

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.  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.  This function gets its data from an external server.

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.  Either the fastest or shorted route can be calculated depending on the routetype parameter.  The description is available in dutch and english, depending on the english parameter toggle.  This function gets its data from an external server.

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.

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.  Either the fastest or shorted route can be calculated depending on the routetype parameter.  This function gets its data from an external server.

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.  Either the fastest or shorted route can be calculated depending on the routetype parameter.  This function gets its data from an external server.

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 information on the fastest route will be returned.  The description is available in several languages depending on the language parameter.  This function gets its data from an external server.

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.

routePlannerEUMap

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.

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.

Type definitions

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.
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 neighborhoodcodes in the Netherlands.
A single route planner information entry.
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.
A route coordinates entry.
A route coordinates entry.