Search for content

API Changes

This list shows all changes of the Routing API between releases like new features, significant improvements and bug fixes. We recommend that API developers periodically check it for updates.

Version 1.33.0

  • Feature: Added response parameter 'timeDomain' to indicate the time validity of violated restrictions.
  • Feature: Added request parameter 'polylineMapType' to the methods 'calculateRoute' and 'calculateRoutePost' to specify whether the response polylines should match the Raster Maps API or the Vector Maps API.
  • Improvement: The performance when using multiple custom road attribute scenarios is improved.
  • Improvement: The explicit declaration 'nullable' is removed from the OpenAPI specification as it is no longer required for the C# client generation.

Version 1.32.3

  • Bugfix: Fixed bugs in toll calculation that can lead to internal server errors when the start or destination waypoint is on a highway.

Version 1.32.1

  • Bugfix: Fixed a bug in ETA calculation that can lead to internal server errors when the route contains multiple waypoints at the same coordinate and one of them is the next waypoint.

Version 1.32.0

  • Feature: Added response parameters 'approximated' and 'containsApproximatedSections' to indicate that the toll price is approximated because start or destination is located inside a toll section.
  • Bugfix: Fixed the sequence of events when charge and waypoint events are requested and there are multiple waypoints with the same coordinates.

Version 1.31.3

  • Bugfix: Fixed a bug when calculating the travel time and using combined-transport waypoints in certain cases.
  • Bugfix: Fixed a bug when using drivers' working hours and consecutive combined-transport waypoints.
  • Bugfix: Fixed the result parameter 'guidedNavigation' to mark the first waypoint as visited.

Version 1.31.2

  • Bugfix: The number of 'openingIntervals' is properly validated to be at most 30.
  • Bugfix: Fixed a bug when using high values for parameter 'maximumSpeed'.

Version 1.31.0

  • Feature: Added request parameter 'speedFactor' to modify the speed of the vehicle.
  • Feature: Added request parameter 'maximumSpeed' to limit the speed of the vehicle.
  • Feature: Added value 'HIGHWAYS' to request parameter 'avoid' to avoid routing on highways.
  • Bugfix: Fixed a bug where schedule events were missing.

Version 1.30.0

  • Feature: Added request parameters 'DELIVERY_ONLY_EVENTS' and 'DELIVERY_ONLY_EVENTS_POLYLINE' to provide delivery-only events in the event list when using roads prohibited except for delivery vehicles.
  • Improvement: Events which cover a short distance now also have access type 'ENTER' and 'EXIT', only violation events which cover a single position such as gates have access type 'PASS'.
  • Bugfix: Fixed a bug where low-emission zone related violation events did not match their corresponding low-emission zone events in some cases.
  • Bugfix: Fixed a bug where low-emission zone events were missing at intermediate waypoints when the intermediate waypoints are located within a low-emission zone.

Version 1.29.3

  • Bugfix: Fixed a bug where an exit event for a combined transport was missing when multiple combined transports are used consecutively.

Version 1.29.1

  • Improvement: The request parameter 'powerConsumptionDuringService' is independent of 'serviceTime' at a waypoint by changing its value to energy [kWh] instead of power [kW].
  • Improvement: The request parameter 'useTimeOnCombinedTransportForRecreation' is automatically set to true in order to correctly schedule breaks and rests when the travel time on a combined transport exceeds the maximum travel time per day.
  • Bugfix: Fixed a bug that lead to internal server errors in special cases when preferring turns on the passenger side.
  • Bugfix: Fixed a bug that lead to internal server errors in special cases using the monetary cost calculation.
  • Bugfix: Fixed a bug where schedule events of type 'SERVICE' were missing on the last waypoint when using opening intervals.
  • Bugfix: Fixed a bug where schedule events of the types SERVICE and WAITING were missing when using a combined transport waypoint.
  • Bugfix: Fixed a bug where the air-line connection between given and matched coordinates was not correctly considered in the values of the parameters 'distanceFromStart' and 'travelTimeFromStart' of events when arriving at an off-road waypoint.

Version 1.29.0

  • Feature: Added request parameter 'powerConsumptionDuringService' to model the average power consumption drained from the battery of an electric vehicle at a waypoint.
  • Feature: Added request parameter 'useServiceTimeForCharging' to use the service time on a waypoint for charging when using an electric vehicle.

Version 1.28.1

  • Bugfix: Schedule events of type 'SERVICE' are assigned to the correct waypoint when several waypoints are at the same location and when there is an additional schedule event of type 'WAITING'.

Version 1.28.0

  • Feature: Added request parameter 'useServiceTimeForRecreation' to the method 'calculateRoutePost' to use the service time on a waypoint for breaks and rests when using working hours.
  • Feature: Added request parameter 'useTimeOnCombinedTransportForRecreation' to the method 'calculateRoutePost' to use the time on combined transports for breaks and rests when using working hours.
  • Bugfix: Time spent on a combined transport is considered as waiting, break or rest time and no longer as driving time as far as the schedule is concerned.
  • Bugfix: Fixed a bug that lead to unexpected results when using a combined transport waypoint for the Channel Tunnel.
  • Bugfix: Fixed a bug where intermediate waypoints at certain roads lead to errors stating that no route could be found.

Version 1.27.5

  • Improvement: Return the warning 'ROUTING_ELEVATIONS_UNAVAILABLE' when calculating the consumption for an electric vehicle in a region where elevation data are not available.

Version 1.27.3

  • Improvement: The restriction that weather for routes more than 90 days in the past was unavailable is now removed.
  • Improvement: If at least one waypoint is inside the allowed time window, weather from weather service can be used.
  • Improvement: When requesting 'EV_STATUTS_EVENTS', it is assured that one event reports the electricity consumption at border crossings.
  • Improvement: The result for reachable areas and locations is improved when the vehicle is not allowed to use the nearest road to the waypoint.
  • Bugfix: A routeId from the method 'calculateRoute' can be used for calculating electricity consumption in the method 'calculateRoutePost'.
  • Bugfix: Events for electric vehicles provide the correct event parameters 'startsAt', 'countryCode' and 'utcOffset'.

Version 1.27.2

  • Improvement: Improved the error code 'GENERAL_MISSING_PARAMETER' for a missing JSON body by making the 'parameter' more specific.

Version 1.27.1

  • Improvement: When calculating electricity consumption with a route, the weather is provided from a weather service, if no weather is explicitly set.

Version 1.27.0

  • Feature: Added request parameter 'emissionOptions' to specify all emission report options including the versions for the ISO 14083 emission calculation.

Version 1.26.0

  • Feature: Added request parameter 'time' for ETA calculation to specify when the vehicle position was captured.

Version 1.25.5

  • Bugfix: Using the vehicle parameter 'lowEmissionZoneApprovals' in combination with electric vehicle models is possible.
  • Bugfix: Return an error when a service cannot be scheduled as it exceeds the maximum time between breaks permitted by the selected working hours.

Version 1.25.4

  • Feature: Added new vehicle profiles for TLN (Transport en Logistiek Nederland) to the predefined profiles. This is in a preview state.
  • Improvement: The warning 'ROUTING_ROADATTRIBUTES_MAYBE_IGNORED' references the not fully considered scenarios.
  • Improvement: When the accumulated number of attributed roads from all custom road attribute scenarios is too large, an error code is returned.
  • Bugfix: Only values greater than 0 are accepted for a given horizon calculating reachable areas and locations.
  • Bugfix: No longer accept incomplete date-time values.

Version 1.25.3

  • Improvement: The warning 'ROUTING_STATE_OF_CHARGE_BELOW_MINIMUM' will be returned when the route may be not feasible with the used electric vehicle.
  • Bugfix: Charge events no longer offset the start time of subsequent events as this could lead to inaccurate results.

Version 1.25.1

  • Bugfix: Fixed a bug when 'EV_CHARGE_EVENTS' are requested.
  • Bugfix: Fixed a bug when requesting a route based on an electric vehicle model by its routeId.

Version 1.25.0

  • Feature: Added support for calculating electricity consumption based on electric vehicle models in the method 'calculateRoutePost'. This is in a preview state.
  • Improvement: The error 'ROUTING_ROUTE_NOT_FOUND' reports the first waypoint with no route found to the next waypoint.
  • Bugfix: Fixed another bug when 'VIOLATION_EVENTS' are requested.

Version 1.24.2

  • Bugfix: Fixed a bug where multiple 'LOW_EMISSION_EVENTS' are returned for the same low-emission zone.

Version 1.24.1

  • Bugfix: Fixed a bug when 'VIOLATION_EVENTS' are requested.

Version 1.24.0

  • Feature: Added support to consider low-emission zones in different European countries.
  • Feature: Added response parameters 'violatedVehicleProperties' and 'temporary' to provide more details for violation events.
  • Improvement: The quality of error messages is improved by revising the request validation.
  • Bugfix: Fixed a bug where routes starting or ending at dead-ends could not be found (also fixed for all routing-related services).
  • Bugfix: Fixed a bug where routes starting or ending in Austria could be different depending on whether or not alternative routes were requested.

Version 1.23.0

  • Feature: Added vehicle request parameter 'totalTechnicallyPermittedWeight' to be considered for toll calculation. The first usage of this feature are new toll tariffs in Austria valid since January 2024.
  • Feature: Added request parameter 'tollTime' to calculate future toll prices on an average route independent of when to travel.
  • Feature: Added response parameter 'violated' to the remaining waypoints of the method 'getEstimatedTimeOfArrival' to mark that there is no valid route from the vehicle position to this waypoint.
  • Improvement: The vehicle property 'emissionStandard' is updated from 'EURO_5' to 'EURO_6' for all predefined profiles.
  • Improvement: A previously calculated route referenced by the parameter 'routeId' will now automatically be updated to a new map instead of returning an error.
  • Bugfix: Time-dependent truck attributes are no longer considered for reachable areas and locations when using traffic mode 'AVERAGE' without a start or arrival time.

Version 1.22.1

  • Improvement: The request parameter 'co2EmissionClass' is no longer experimental.
  • Bugfix: Fixed a bug where the service started one second before the waypoint opens in certain cases.

Version 1.22.0

  • Feature: Added method 'getEstimatedTimeOfArrival' to provide the estimated time of arrival (ETA) based on a previously calculated route and the current position of the vehicle.
  • Feature: Added support for additional working hours presets to the method 'calculateRoutePost'.
  • Improvement: The request parameter 'customRoadAttributeScenarios' is no longer experimental.
  • Improvement: Changed the type of string arrays in the types 'Vehicle' and 'Options' to string in order to avoid undefined behavior. Queries will remain the same. When using generated clients updating some calls may be necessary.
  • Bugfix: Fixed a bug where a toll event of access type 'EXIT' was missing when crossing the border to another country.
  • Bugfix: Fixed order of events when waypoint events and multiple schedule events occur at the same location. The waypoint event is now always returned with the first schedule event.
  • Bugfix: Removed unnecessary 'nullable' declaration from several properties.

Version 1.21.4

  • Improvement: The waypoint limit for the method 'calculateRoutePost' is increased from 25 to 250.

Version 1.21.2

  • Bugfix: The total service time of the schedule report is correctly calculated and no waiting time is included.
  • Bugfix: The schedule type 'WAITING' of the schedule events is removed in case there is another schedule type like 'BREAK' present in parallel.

Version 1.21.0

  • Feature: Added request parameter 'customRoadAttributeScenarios' to be considered during the route calculation. This parameter is in an experimental state and may change at any time.
  • Improvement: When the route calculation times out the new error code 'ROUTING_TIMEOUT' is returned instead of a 'GENERAL_INTERNAL_ERROR'.

Version 1.20.0

  • Feature: Added support for the ISO 14083 version 2023 emission calculation.
  • Feature: Added request parameter 'co2EmissionClass' to consider the emission class in the upcoming German toll tariffs planned for December 2023. This parameter is in an experimental state and may change at any time.
  • Improvement: The warning 'ROUTING_DATE_UNSUPPORTED_PERIOD' will no longer be returned when the start or arrival time are in the past or in the future.

Version 1.19.1

  • Improvement: The quality for reachable areas and locations is improved by no longer considering through, origin and destination traffic.
  • Bugfix: Fixed a routing error when setting vehicle parameters at the first waypoint.
  • Bugfix: Fixed a routing error when using vehicle parameter 'tunnelRestrictionCode' at a waypoint without setting 'hazardousMaterials'.

Version 1.19.0

  • Feature: Added response parameter 'calculatedDistance' to the toll sections to provide an alternative for the not always available official distance of the toll operator.
  • Improvement: The toll event type 'PASS' is substituted by pairs of type 'ENTER' and 'EXIT'.

Version 1.18.1

  • Bugfix: No longer return an error when requesting the 'TOLL_SYSTEMS' without 'TOLL_SECTIONS' or 'TOLL_COSTS'.

Version 1.18.0

  • Feature: Added request parameter 'workLogbook' to the method 'calculateRoutePost' to consider already conducted work of the driver in the working hours calculation.
  • Bugfix: Return an error when parameter 'blockIntersectingRoads' contains a polyline with less than two points.

Version 1.17.1

  • Bugfix: Fixed a routing error when using special combined transport waypoints.

Version 1.17.0

  • Improvement: If the first waypoint or the routeId is located in the Americas but a non-American profile is specified, a warning is returned (only for the methods 'calculateRoute' and 'calculateRoutePost').
  • Improvement: If no profile is specified and the first waypoint or the routeId is located in the Americas, 'USA_8_SEMITRAILER_5AXLE' is used as the default instead of 'EUR_TRAILER_TRUCK' to return better results.

Version 1.16.0

  • Feature: Added request parameter 'TRAFFIC_EVENTS_POLYLINE' to provide the polylines of the affected parts of the route along with the traffic events.
  • Improvement: The performance for routes avoiding toll is improved.

Version 1.15.2

  • Improvement: Routing requests with waypoints on different continents return immediately if no route can be found.

Version 1.15.0

  • Feature: Added support for the truck routes 'NZ_HPMV', 'AU_B_DOUBLE_HML', 'AU_B_TRIPLE_HML', 'AU_AB_TRIPLE', 'AU_AB_TRIPLE_HML'.

Version 1.14.4

  • Bugfix: Return proper error message when using conflicting low-emission zone types.

Version 1.14.2

  • Bugfix: Fixed calculation of HBEFA-related emissions using EURO_0 vehicles.

Version 1.14.0

  • Feature: Added request parameter 'vehicleParameters' to 'onRoad' and 'offRoad' waypoints of the method 'calculateRoutePost' to get more accurate results for the next leg by changing some vehicle parameters at each intermediate waypoint.
  • Feature: Added support for the ISO 14083 emission calculation.
  • Feature: Added support for alternative engines (LNG, Electric, Hybrid) for the emission calculation by introducing several new vehicle request parameters.
  • Feature: Added support for the emission standard 'EURO_6D_TEMP', 'EURO_6D' and 'EURO_6E' of vehicles in the European Union.
  • Feature: Added request parameter 'numberOfTires' to consider the total number of tires of the vehicle in the toll calculation.
  • Feature: Added request parameter 'costPerKwh' in the monetary cost options to support electric engines.

Version 1.13.0

  • Feature: Added new vehicle profiles for the IMEA region.
  • Feature: Added request parameter 'routingMode' to optimize route calculation for travel time, distance and monetary costs.
  • Feature: Added request parameter 'MONETARY_COSTS' to provide a report with monetary costs of a route based on monetary options like cost per kilometer or per hour.

Version 1.12.0

  • Feature: Added request parameter 'VIOLATION_EVENTS_POLYLINE' to provide the polylines of the violated parts of the route along with the violation events.

Version 1.11.0

  • Feature: Added request parameter 'blockIntersectingRoads' to block roads and combined transports that intersect the given polylines.
  • Feature: Added request parameter 'TRAFFIC_EVENTS' to provide traffic events in the event list such as traffic jams passed by the route.
  • Feature: Added request parameter 'GUIDED_NAVIGATION' to get an additional route format to be imported in PTV Navigator and used for guided navigation there.
  • Improvement: Added subscription 'US_EZPASS_PAYBYPLATE' to the electronic toll collection systems.

Version 1.10.0

  • Feature: Added support for working hours preset 'US_HOURS_OF_SERVICE_REGULATIONS_FOR_MULTIPLE_DAYS' to the method 'calculateRoutePost'.
  • Feature: Added support for both US working hours presets using the latest rule change from 2020 issued by FMCSA.
  • Improvement: Renamed error codes 'GENERAL_ACCESS_DENIED' to 'GENERAL_UNAUTHENTICATED' and 'GENERAL_UNAUTHORIZED' to 'GENERAL_FORBIDDEN'.

Version 1.9.0

  • Feature: Added waypoint type 'combinedTransport' to use a specific ferry or rail shuttle connection on the route.
  • Improvement: Route-manipulation waypoints are now allowed in combination with drivers' working hours including service times and opening intervals.
  • Improvement: Improved the response of the error code 'GENERAL_PARSING_ERROR' for an invalid JSON body.

Version 1.8.0

  • Feature: Added response parameter 'trafficDelay' to obtain the delay due to live traffic for the route, legs and alternative routes.
  • Bugfix: When using the profile 'USA_8_SEMITRAILER_5AXLE' the proper vehicle attributes of typical semi-trailer truck (US GVWR class 8) with 5 axles are now used.

Version 1.7.0

  • Feature: Added request parameter 'avoid' to avoid features like toll roads or ferries on a route if possible.

Version 1.6.0

  • Feature: Added request and response parameter 'etcSubscriptions' to consider the available subscriptions of electronic toll collection systems the vehicle can use.
  • Improvement: When the distance from a waypoint to the nearest accessible road is greater than 1000 meters a warning is returned.
  • Bugfix: When using 'VIOLATION_EVENTS' a proper response instead of an error is returned.

Version 1.5.0

  • Feature: Added method 'calculateRoutePost' to consider drivers' working hours for EU and USA, service times and opening intervals.
  • Feature: Added parameter 'preferTurnsOnPassengerSide' to prefer turns on the passenger side as it can reduce waiting times and enhance safety.
  • Bugfix: For requests running in parallel, the correct requested currency conversion is now delivered in the response.

Version 1.4.0

  • Feature: Added waypoint attribute 'matchSideOfStreet' to manipulate which side of a street should be used preventing the driver from crossing the street.

Version 1.3.0

  • Feature: Added request parameter 'currency' and response parameter 'convertedPrice' to convert all toll prices to the selected currency.
  • Feature: Added response parameter 'currencies' to get information about the used exchange rates that are updated on a daily basis.
  • Improvement: The emission calculation does no longer require the parameter 'averageFuelConsumption'. If not specified, the default value of the selected vehicle is used.
  • Improvement: When using the parameter 'truckRoutes' with non-truck profiles like car or van a warning is returned.
  • Improvement: When using the parameter 'routeId' together with allowed or prohibited countries a warning is returned.
  • Improvement: When using the parameter 'routeId' from another service such as map matching in the method 'getRouteByRouteId' an error code is returned.
  • Improvement: When using the parameter 'routeId' in the methods 'startAndCreateReachableAreas' and 'startAndCreateReachableLocations' and the allowed or prohibited countries violate parts of the given route an error code is returned.
  • Improvement: Renamed error codes 'ROUTING_DISTANCE_TOO_LONG' to 'ROUTING_ESTIMATED_DISTANCE_TOO_LONG' and 'ROUTING_ROUTE_TOO_LONG' to 'ROUTING_ROUTE_TOO_LONG_FOR_REACHABILITY'.
  • Improvement: Renamed error code 'ROUTING_UTCOFFSET_CANNOT_DETERMINED' to 'ROUTING_UTC_OFFSET_CANNOT_BE_DETERMINED'.
  • Improvement: Moved error code 'ROUTING_TOO_MANY_WAYPOINTS' to the new error code 'ROUTING_RESTRICTION_EXCEEDED' with HTTP status code 403.
  • Improvement: Several details of error codes are now of type integer instead of string.
  • Bugfix: Return HTTP status code 202 instead of 200 for the methods 'startAndCreateReachableAreas' and 'startAndCreateReachableLocations'.
  • Bugfix: Return an empty array instead of null for the parameter 'unreachable' in the method 'getReachableLocations' when all locations are reachable.
  • Bugfix: Return a properly formatted error response when requesting an invalid parameter 'routeId' in the method 'getRouteById'.

Version 1.2.7

  • Improvement: For the emission calculation 'EMISSIONS_EN16258_2012_HBEFA' HBEFA is updated to version 4.1.

Version 1.2.1

  • Improvement: An error for reachable areas and locations is returned when the distance of the given parameter 'routeId' is greater than 500 km.
  • Improvement: Additional road restrictions for the vehicle profiles 'EUR_VAN' and 'EUR_CAR' are considered during the route calculation.

Version 1.2.0

  • Feature: Added synchronous and asynchronous methods to calculate reachable areas within given horizons.
  • Feature: Added asynchronous methods to calculate reachable locations within a given horizon.
  • Feature: Added parameter 'routeId' to recalculate a previously calculated route instead of using the waypoint list.
  • Feature: Added new vehicle profiles for the USA and Australia.
  • Improvement: A warning instead of an error is returned when live traffic data are temporarily unavailable.

Version 1.1.0

  • Feature: Added method 'getRouteByRouteId' to get more details of a previously calculated or alternative route.
  • Feature: Added support for allowed and prohibited countries considered during the route calculation.
  • Bugfix: The z-coordinate in the polyline is no longer returned when requesting the emission result 'EMISSIONS_EN16258_2012_HBEFA'.

Version 1.0.0

  • Feature: Considering different waypoint types (on-road, off-road and route-manipulation).
  • Feature: Selecting one of the provided vehicles with the possibility to customize several attributes.
  • Feature: Considering the different traffic situations with an easy-to-use mode.
  • Feature: Providing three alternative routes in addition to the optimal route.
  • Feature: Providing detailed toll data (costs, sections and systems).
  • Feature: Providing emission data (CEN and French CO2E decree).
  • Feature: Providing events in chronological order (e.g. maneuvers, border crossings, toll).