Migration Guide
Where do I find the Orbis V3 end point
The Orbis Routing API V3 end point is:
post
URL request format
https://{baseURL}/maps/orbis/routing/routes/calculate?key={Your_API_Key}&apiVersion={apiVersion}&{param=value}Changes from Genesis to Orbis V3 in the parameters or responses
- The base path parameter
routePlanningLocationshas been removed.- Please use the
routePlanningLocationsPOST data parameter instead. The locations are specified in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 .- As a consequence, only
POSTmethod is supported.
- As a consequence, only
- Please use the
formatVersionhas been removed from the response.- Either
apiVersionquery parameter orTomTom-Api-Versionheader needs to be present. - The query parameter
routeTypehas been removed In Orbis. Please use therouteTypePOST data parameter instead. It has a new set of values in Orbis:fast,short,efficient, andthrilling.- Please use
fastinstead offastest,shortinstead ofshortest, andefficientinstead ofeco.
- Please use
- The POST data parameter
routeTypein thelegsobject has a new set of values in Orbis:fast,short,efficient, andthrilling.- Please use
fastinstead offastest,shortinstead ofshortest, andefficientinstead ofeco.
- Please use
- The query parameter
traffichas a new set of values in Orbis:liveandhistorical.- Please use
liveinstead oftrueandhistoricalinstead offalse.
- Please use
- The query parameter
travelModehas been removed In Orbis. Please use thetravelModePOST data parameter instead. - The POST data parameter parameter
travelModeonly supportscarin Orbis. - The query parameter
vehicleEngineTypehas been removed In Orbis. Please use thevehicleEngineTypePOST data parameter instead. - The query parameter
arrivalSidePreferencehas been removed In Orbis. Please use thearrivalSidePreferencePOST data parameter instead. - The query parameter
keyhas been replaced with theTomTom-Api-Keyheader. simpleCategoryhas been replaced byiconCategorywith new values:accident,brokenDownVehicle,dangerousConditions,flooding,fog,ice,jam,laneClosed,rain,roadClosed,roadWorks,wind,unknowndelayInSecondshas been replaced bydelayDurationInSecondsmagnitudeOfDelayhas been replaced bydelayMagnitudewith new values:unknown,minor,moderate,major,undefined- Response headers
PragmaandWarninghave been removed. - The query parameter
alternativeTypehas been removed. - The query parameter
minDeviationDistancehas been removed. - The query parameter
minDeviationTimehas been removed. - The query parameter
supportingPointIndexOfOriginhas been removed. - The query parameter
reconstructionModehas been removed. - The query parameter
constantSpeedConsumptionInLitersPerHundredkmhas been removed.- As a consequence, the response field
fuelConsumptionInLitershas been removed from thesummary.
- As a consequence, the response field
- The query parameter
currentFuelInLitershas been removed. - The query parameter
auxiliaryPowerInLitersPerHourhas been removed. - The query parameter
fuelEnergyDensityInMJoulesPerLiterhas been removed. - The query parameter
accelerationEfficiencyhas been removed. - The query parameter
decelerationEfficiencyhas been removed. - The query parameter
uphillEfficiencyhas been removed. - The query parameter
downhillEfficiencyhas been removed. - The query parameter
constantSpeedConsumptionInkWhPerHundredkmhas been removed.- As a consequence, the response field
batteryConsumptionInkWhhas been removed from thesummary.
- As a consequence, the response field
- The query parameter
currentChargeInkWhhas been removed. - The query parameter
maxChargeInkWhhas been removed. - The query parameter
auxiliaryPowerInkWhas been removed. - The query parameter
consumptionInkWhPerkmAltitudeGainhas been removed. - The query parameter
recuperationInkWhPerkmAltitudeLosshas been removed. - The POST data parameter
encodedPolylinehas been removed. - The POST data parameter
encodedPolylinePrecisionhas been removed. - The POST data parameter
pointWaypointshas been removed.- As a consequence, the POST data parameter
pointWaypointhas been removed.- As a consequence, POST data parameters
waypointSourceTypeandsupportingPointIndexhave been removed.
- As a consequence, POST data parameters
- As a consequence, the POST data parameter
- The POST data parameters
encodedPolylineandencodedPolylinePrecisionhave been removed from thelegsPOST data parameter. - The response field
planningReasonhas been removed from thesummary. - The POST data parameter
pauseTimeInSecondshas been renamed topauseDurationInSeconds. - The response field
userDefinedPauseTimeInSecondshas been removed from thesummary. - The response field
encodedPolylinehas been removed from thelegs. - The response field
encodedPolylinePrecisionhas been removed from thelegs. - The query parameter
departAthas been removed.- Please use the
departureDateTimePOST data parameter instead.
- Please use the
- The query parameter
arriveAthas been removed.- Please use the
arrivalDateTimePOST data parameter instead.
- Please use the
- The response field
encodedPolylinehas been removed. Now its value is represented in the newcompressedPath’sdatafield. - The response field
encodedPolylinePrecisionhas been removed. Now its value is represented in the newcompressedPath’sprecisionfield. - The response field
compressedPathis new output field for encoded polyline route representation. - The response field
pointshas been renamed topathand is now in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 . - The response field
deviationPointis now in GeoJSON format. For more details, refer to the RFC 7946 . - The POST data parameter
entryPointsinrouteStopnow uses GeoJSON MultiPoint format instead of an array of objects withlatitudeandlongitude. For more details about GeoJSON, refer to the RFC 7946 . - The response field
countryCodehas been renamed tocountryCodeIso2. It follows ISO 3166-1 alpha-2 standard. - The response field
travelTimeInSecondsin theroute.summaryandleg.summaryhas been renamed totravelDurationInSeconds. - The response field
trafficDelayInSecondsin theroute.summaryandleg.summaryhas been renamed totrafficDelayDurationInSeconds. - The response field
departureTimein theroute.summaryandleg.summaryhas been renamed todepartureDateTime. - The response field
arrivalTimein theroute.summaryandleg.summaryhas been renamed toarrivalDateTime. - The response field
sectionshas changed from an array of section objects to a map of arrays. Each key in the map is a section type and each value is an array of section objects of that type. ThesectionTypefield has been removed from individual section objects. - The response field
startPointIndexin thesectionobjects has been renamed tostartPathIndexand the response fieldendPointIndexhas been renamed toendPathIndex. - The
speedlimitsectionobject has new fields. ThemaxSpeedLimitInKilometersPerHourhas been replaced with thespeedRestrictionslist of objects. Please refer to the API documentation for details about thespeedRestrictionslist of objects.
Changes from Genesis to Orbis V3 in the features
- Only the
calculateRouteservice is available in Orbis. - The base path parameter
contentTypehas been removed in Orbis.- The response content type can be specified with the
Acceptrequest header.
- The response content type can be specified with the
- The base path parameter
routePlanningLocationshas been removed.- Please use the
routePlanningLocationsPOST data parameter instead. The locations are specified in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 .- As a consequence, only
POSTmethod is supported.
- As a consequence, only
- Please use the
- Only JSON responses are supported in Orbis.
- As a consequence, the
statusCodefield is not provided in the response in Orbis. - The query parameter
callbackhas been removed in Orbis.
- As a consequence, the
- Guidance instructions are now controlled via a new
guidancePOST data parameter instead of theinstructionsTypequery parameter.- Set
guidancetoinstructionsto enable guidance. Omit it or set tononeto disable. - The Genesis
coded/text/taggeddistinction no longer exists. Human-readable instruction messages are included by default when guidance is enabled. To exclude them, use theAttributes-Excludeheader withroutes.instructions.message. - The
taggedmessage format is no longer available. - The
instructionPhoneticsparameter has been moved from a query parameter to a mandatory POST data parameter with lowercase values (ipainstead ofIPA,lhpinstead ofLHP). Thenonevalue has been removed — one of the supported values (ipaorlhp) must be provided when guidance is enabled. - The query parameter
languagehas been removed in Orbis. Please use theAccept-Languagerequest header instead. - The header
Content-Languageis now included in the response to indicate the language used when selecting language‑dependent data. - The query parameter
instructionAnnouncementPointshas been removed in Orbis. Instruction announcement points (earlyWarningAnnouncement,mainAnnouncement,confirmationAnnouncement) are no longer supported. - The query parameter
instructionRoadShieldReferenceshas been removed in Orbis. Road shield data is now included automatically inRoadInformation.roadShieldswhen guidance is enabled.- As a consequence, the
roadShieldAtlasReferencefield is not provided in the response in Orbis. The Genesis atlas-based model (wherereferencesprite keys were resolved against an external sprite sheet URL) has been replaced by self-containedRoadShieldobjects that embed the road number, country code, and phonetic information directly.
- As a consequence, the
- The response structure has been simplified: guidance instructions are returned directly in
routes[].instructions[]instead ofroutes[].guidance.instructions[]. - The
instructionGroupsarray (firstInstructionIndex,lastInstructionIndex,groupLengthInMeters,groupMessage) has been removed. - Combined messages (
combinedMessageandpossibleCombineWithNext) have been removed. - The instruction object has been significantly restructured:
point(object withlatitude/longitude) has been replaced bymaneuverPoint(GeoJSON Point).pointIndexhas been removed. Replaced by theroutePatharray ofRoutePathPointobjects withpoint,distanceFromRouteStartInMeters, andtravelTimeFromRouteStartInSeconds.travelTimeInSecondshas been removed. In V3, travel time per point is available viaRoutePathPoint.travelTimeFromRouteStartInSecondsin theroutePatharray.instructionTypehas been removed. The instruction type is inferred from themaneuvercode.junctionType(REGULAR,ROUNDABOUT,BIFURCATION) has been removed.turnAngleInDecimalDegreeshas been replaced bychangeOfAngleInDegrees, with changes to both scope and semantics:- No longer present for fork maneuvers (
keepLeft,keepRight,keepCenter), which correspond to the GenesisBIFURCATIONjunctionType. - Now also present for roundabout maneuvers (
roundaboutStraight,roundaboutRight, etc.), which did not have this field in Genesis. Note thatexitRoundaboutis excluded and does not carry this field. - The semantics differ: Genesis indicated the direction of the instruction; Orbis V3 represents the total change of angle from entry to exit of the maneuver, within the range
[-180, 180).
- No longer present for fork maneuvers (
streethas been removed. Street information is now inpreviousRoadInformationandnextRoadInformationas structuredRoadInformationobjects withproperties,roadShields,roadNumbers,roadNames, andcountryCodeIso2.roadNumbers(array of strings) has been removed from the instruction root. Now available asRoadInformation.roadNumbers, an array ofRoadIdentifierobjects with phonetic information, source, and road attribute.signpostTextandexitNumber(string) have been removed. Replaced by the structuredsignpostobject withexitName,exitNumber, andtowardName(each asTextWithPhonetics).countryCode(ISO 3166-1 alpha-3) has been removed from the instruction root. Country code is now inRoadInformation.countryCodeIso2(ISO 3166-1 alpha-2).stateCode(subdivision part only, e.g.,AN) has been removed from the instruction root. NowRoadShield.countrySubdivisionCodeIsowith full ISO 3166-2 code (e.g.,ES-AN).- Phonetic fields (
phoneticStreet,phoneticStreetLanguageCode,phoneticSignpostText,phoneticSignpostTextLanguageCode,phoneticRoadNumbers,phoneticRoadNumberLanguageCodes) have been removed. Phonetic information is now bundled with each name in theTextWithPhoneticspattern (text,phonetic,phoneticLanguageCode). roadShieldReferencesandsignpostRoadShieldReferencesarrays have been removed. Road shield data is now structured withinRoadInformation.roadShieldsasRoadShieldobjects.
- New fields in V3 with no Genesis equivalent:
routePath— array ofRoutePathPointobjects defining the maneuver geometry.maneuverView— schematic representation of the intersection (onRouteAngle,offRouteAngles).previousRoadInformation/nextRoadInformation— structuredRoadInformationobjects.signpost— structured object withexitName,exitNumber, andtowardName(each asTextWithPhonetics).intersectionName— name of the intersection at the maneuver (TextWithPhonetics).isManeuverObligatory— marks a turn maneuver as obligatory.roundaboutType— indicates roundabout type (regularorsmall).tollgateName— name of the tollgate (TextWithPhonetics).tollPaymentTypes— array of available payment options at a tollgate.countryCrossingFromName/countryCrossingToName— country names for border crossings (TextWithPhonetics).countryCrossingFromCodeIso2/countryCrossingToCodeIso2— country codes (ISO 3166-1 alpha-2) for border crossings.landmark— notable feature near the maneuver (e.g.,atTrafficLight,intoTunnel).ambiguousExitOffsetFromManeuverInMeters— offset of an ambiguous exit before the maneuver.sideRoads— list of roads connecting to the route before the maneuver.mergePointRouteOffsetInMeters— route offset where the route merges onto a new motorway.
- All enum values have changed from
UPPER_SNAKE_CASEtocamelCase(e.g.,KEEP_RIGHT→keepRight,LEFT→left). - Maneuver code changes from Genesis to V3:
- Direct casing changes:
DEPART→depart,ARRIVE→arrive,ARRIVE_LEFT→arriveLeft,ARRIVE_RIGHT→arriveRight,KEEP_RIGHT→keepRight,KEEP_LEFT→keepLeft,TURN_RIGHT→turnRight,TURN_LEFT→turnLeft,MAKE_UTURN→makeUTurn,ROUNDABOUT_RIGHT→roundaboutRight,ROUNDABOUT_LEFT→roundaboutLeft,ROUNDABOUT_BACK→roundaboutBack,WAYPOINT_REACHED→waypointReached,WAYPOINT_LEFT→waypointLeft,WAYPOINT_RIGHT→waypointRight. - Renamed (not just casing):
STRAIGHT→continueStraight,BEAR_RIGHT→turnSlightRight,BEAR_LEFT→turnSlightLeft,SHARP_RIGHT→turnSharpRight,SHARP_LEFT→turnSharpLeft,ROUNDABOUT_CROSS→roundaboutStraight,MOTORWAY_EXIT_LEFT→exitMotorwayLeft,MOTORWAY_EXIT_RIGHT→exitMotorwayRight,TAKE_FERRY→takeShipFerry. - Removed (no V3 equivalent):
ENTER_MOTORWAY,ENTER_FREEWAY,ENTER_HIGHWAY,TAKE_EXIT,TRY_MAKE_UTURN,FOLLOW,SWITCH_PARALLEL_ROAD,SWITCH_MAIN_ROAD,ENTRANCE_RAMP. - New in V3:
waypointAhead,arriveAhead,keepCenter,roundaboutSharpRight,roundaboutSlightRight,roundaboutSharpLeft,roundaboutSlightLeft,exitRoundabout,exitMotorwayMiddle,switchMotorwayLeft,switchMotorwayRight,switchMotorwayMiddle,enterCarpoolLaneLeft,enterCarpoolLaneRight,exitCarpoolLaneLeft,exitCarpoolLaneRight,mergeLeftLane,mergeRightLane,leaveShipFerry,takeCarTrain,leaveCarTrain,crossBorder,passTollgate.
- Direct casing changes:
- Set
lanessections are not supported and are not provided in the response in Orbis.- See Guidance Instructions for the full V3 specification.
roadShieldssections are not supported and are not provided in the response in Orbis.- As a consequence, the
roadShieldAtlasReferencefield is not provided in the response in Orbis.
- As a consequence, the
tollRoadsandtollVignettesections are not supported and are not provided in the response in Orbis.- As a consequence, sections with
sectionTypeTOLLprovide sections which include either a usage-based toll or toll vignette, in the response in Orbis.
- As a consequence, sections with
circlewaypoints are not supported in Orbis.- The query parameter
coordinatePrecisionhas been removed in Orbis.- Responses contain full precision coordinates in Orbis.
- The query parameter
computeBestOrderhas been removed in Orbis.- As a consequence, the
optimizedWaypointsfield is not provided in the response in Orbis.
- As a consequence, the
- The query parameter
computeTravelTimeForhas been removed in Orbis.- As a consequence, the
noTrafficTravelTimeInSeconds,historicTrafficTravelTimeInSeconds, andliveTrafficIncidentsTravelTimeInSecondsfields are not provided in the response in Orbis.
- As a consequence, the
- The query parameter
reporthas been removed in Orbis.- As a consequence, the
effectiveSettingsfield is not provided in the response in Orbis.
- As a consequence, the
- The query parameter
preferhas been removed in Orbis. handsFreeDrivingsections are not supported and are not provided in the response in Orbis.- The query parameter
handsFreeDrivingCapabilityhas been removed in Orbis. - The query parameter
hillinesshas been removed in Orbis. - The query parameter
windingnesshas been removed in Orbis. - The query parameter
vehicleAxleWeighthas been removed in Orbis. - The query parameter
vehicleNumberOfAxleshas been removed in Orbis. - The query parameter
vehicleLengthhas been removed in Orbis. - The query parameter
vehicleWidthhas been removed in Orbis. - The query parameter
vehicleHeighthas been removed in Orbis. - The query parameter
vehicleCommercialhas been removed in Orbis. - The query parameter
vehicleLoadTypehas been removed in Orbis. - The query parameter
vehicleAdrTunnelRestrictionCodehas been removed in Orbis. - The query parameter
chargeMarginsInkWhhas been removed in Orbis.- As a consequence, the
reachableRouteOffsetsfield is not provided in the response in Orbis.
- As a consequence, the
- The POST data parameter
avoidVignettehas been removed in Orbis. - The POST data parameter
allowVignettehas been removed in Orbis. - The POST data parameter
reassessmentParameterSetshas been removed in Orbis.- As a consequence, the
routeReassessmentsfield is not provided in the response in Orbis.
- As a consequence, the
- The POST data parameter
hillinessin thelegsobject has been removed in Orbis. - The POST data parameter
windingnessin thelegsobject has been removed in Orbis. - The POST data parameter
supportingPoints(both inlegsand for the whole route) has been replaced with thepathparameter and is now in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 . - The query parameter
vehicleHeadinghas been replaced with the POST data parametervehicleHeadingInDegreesin Orbis. - The query parameter
vehicleHasElectricTollCollectionTransponderhas been replaced with the POST data parametervehicleHasElectronicTollCollectionTransponderin Orbis. - The query parameter
vehicleMaxSpeedhas been replaced with the POST data parametervehicleMaxSpeedInKilometersPerHourin Orbis. - The query parameter
vehicleWeighthas been replaced with the post data parametervehicleWeightInKilogramsin Orbis. - The query parameter
maxAlternativeshas been removed in Orbis. Please use themaxPathAlternativeRoutesPOST data parameter instead. - The query parameter
avoidhas been removed in Orbis. Please use theavoidsPOST data parameter instead. Theavoidsparameter now takes an array of avoid enum values.- The
lowEmissionZonesavoid value is not supported in Orbis V3.
- The
- the POST data parameter
rectanglesinsideavoidAreasnow uses GeoJSON Feature format instead of specifyingsouthWestCornerandnorthEastCorner. For more details about GeoJSON, refer to the RFC 7946 . - The
/routing/calculateRouteendpoint has been renamed to/routing/routes/calculate. - The
Attributesrequest header is now required. It specifies which response fields to include using dot-notation. Some response fields are marked as EXPLICIT and must be explicitly listed in this header. See the API documentation for the Response field selection section. - The
Attributes-Excluderequest header is now available (optional). It specifies which response fields to exclude using dot-notation. - The query parameter
routeRepresentationhas been removed.- Please select the desired route representation using the
AttributesandAttributes-Excluderequest headers.
- Please select the desired route representation using the
- The query parameter
sectionTypehas been removed.- Please select the sections as needed using the
AttributesandAttributes-Excluderequest headers.
- Please select the sections as needed using the
- The query parameter
extendedRouteRepresentationhas been removed. - The response
progressobject has been replaced withprogressPoints.- Please select the
progressPointsfields as needed using theAttributesandAttributes-Excluderequest headers. - The fields in
progressPointsdiffer from the previousprogressobject:pointIndexhas been renamed topathIndex.travelTimeInSecondshas been renamed totravelDurationInSeconds.batteryConsumptionInkWhhas been removed.
- Please select the
Changes from Orbis V2 to Orbis V3
- The base path parameter
contentTypehas been removed.- The response content type can be specified with the
Acceptrequest header.
- The response content type can be specified with the
- The base path parameter
routePlanningLocationshas been removed.- Please use the
routePlanningLocationsPOST data parameter instead. The locations are specified in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 .- As a consequence, only
POSTmethod is supported.
- As a consequence, only
- Please use the
formatVersionhas been removed from the response.- The query parameter
keyhas been replaced with theTomTom-Api-Keyheader. simpleCategoryhas been replaced byiconCategorywith new values:accident,brokenDownVehicle,dangerousConditions,flooding,fog,ice,jam,laneClosed,rain,roadClosed,roadWorks,wind,unknowndelayInSecondshas been replaced bydelayDurationInSecondsmagnitudeOfDelayhas been replaced bydelayMagnitudewith new values:unknown,minor,moderate,major,undefined- Response headers
PragmaandWarninghave been removed. - The POST data parameter
supportingPoints(both inlegsand for the whole route) has been replaced with thepathparameter and is now in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 . - The POST data parameter
entryPointsinrouteStopnow uses GeoJSON MultiPoint format instead of an array of objects withlatitudeandlongitude. For more details about GeoJSON, refer to the RFC 7946 . - The query parameter
alternativeTypehas been removed. - The query parameter
minDeviationDistancehas been removed. - The query parameter
minDeviationTimehas been removed. - The query parameter
supportingPointIndexOfOriginhas been removed. - The query parameter
reconstructionModehas been removed. - The query parameter
constantSpeedConsumptionInLitersPerHundredkmhas been removed.- As a consequence, the response field
fuelConsumptionInLitershas been removed from thesummary.
- As a consequence, the response field
- The query parameter
currentFuelInLitershas been removed. - The query parameter
auxiliaryPowerInLitersPerHourhas been removed. - The query parameter
fuelEnergyDensityInMJoulesPerLiterhas been removed. - The query parameter
accelerationEfficiencyhas been removed. - The query parameter
decelerationEfficiencyhas been removed. - The query parameter
uphillEfficiencyhas been removed. - The query parameter
downhillEfficiencyhas been removed. - The query parameter
constantSpeedConsumptionInkWhPerHundredkmhas been removed.- As a consequence, the response field
batteryConsumptionInkWhhas been removed from thesummary.
- As a consequence, the response field
- The query parameter
currentChargeInkWhhas been removed. - The query parameter
maxChargeInkWhhas been removed. - The query parameter
auxiliaryPowerInkWhas been removed. - The query parameter
consumptionInkWhPerkmAltitudeGainhas been removed. - The query parameter
recuperationInkWhPerkmAltitudeLosshas been removed. - The POST data parameter
encodedPolylinehas been removed. - The POST data parameter
encodedPolylinePrecisionhas been removed. - The POST data parameter
pointWaypointshas been removed.- As a consequence, POST data parameter
pointWaypointhas been removed.- As a consequence, POST data parameters
waypointSourceTypeandsupportingPointIndexhave been removed.
- As a consequence, POST data parameters
- As a consequence, POST data parameter
- The POST data parameters
encodedPolylineandencodedPolylinePrecisionhave been removed from thelegsPOST data parameter. - The response field
planningReasonhas been removed from thesummary. - The POST data parameter
pauseTimeInSecondshas been renamed topauseDurationInSeconds. - The response field
userDefinedPauseTimeInSecondshas been removed from thesummary. - The response field
encodedPolylinehas been removed from thelegs. - The response field
encodedPolylinePrecisionhas been removed from thelegs. - The query parameter
departAthas been removed.- Please use the
departureDateTimePOST data parameter instead.
- Please use the
- The query parameter
arriveAthas been removed.- Please use the
arrivalDateTimePOST data parameter instead.
- Please use the
- The response field
encodedPolylinehas been removed. Now its value is represented in the newcompressedPath’sdatafield. - The response field
encodedPolylinePrecisionhas been removed. Now its value is represented in the newcompressedPath’sprecisionfield. - The response field
compressedPathis new output field for encoded polyline route representation. - The response field
pointshas been renamed topathand is now in GeoJSON format. For more details about GeoJSON, refer to the RFC 7946 . - The response field
deviationPointis now in GeoJSON format. For more details, refer to the RFC 7946 . - The response field
countryCodehas been renamed tocountryCodeIso2. It follows ISO 3166-1 alpha-2 standard. - The response field
travelTimeInSecondsin theroute.summaryandleg.summaryhas been renamed totravelDurationInSeconds. - The response field
trafficDelayInSecondsin theroute.summaryandleg.summaryhas been renamed totrafficDelayDurationInSeconds. - The response field
departureTimein theroute.summaryandleg.summaryhas been renamed todepartureDateTime. - The response field
arrivalTimein theroute.summaryandleg.summaryhas been renamed toarrivalDateTime. - The query parameter
headinghas been replaced with the POST data parametervehicleHeadingInDegrees. - The query parameter
vehicleHasElectricTollCollectionTransponderhas been replaced with the POST data parametervehicleHasElectronicTollCollectionTransponder. - The query parameter
vehicleMaxSpeedhas been replaced with the POST data parametervehicleMaxSpeedInKilometersPerHour. - The query parameter
vehicleWeighthas been replaced with the post data parametervehicleWeightInKilograms. - The query parameter
maxAlternativeshas been removed. Please use themaxPathAlternativeRoutesPOST data parameter instead. - The query parameter
avoidhas been removed. Please use theavoidsPOST data parameter instead. Theavoidsparameter now takes an array of avoid enum values.- The
lowEmissionZonesavoid value is not supported in Orbis V3.
- The
- The POST data parameter
entryPointsinrouteStopnow uses GeoJSON MultiPoint format instead of an array of objects withlatitudeandlongitude. For more details about GeoJSON, refer to the RFC 7946 . - The query parameter
routeTypehas been removed. Please use therouteTypePOST data parameter instead. - the POST data parameter
rectanglesinsideavoidAreasnow uses GeoJSON Feature format instead of specifyingsouthWestCornerandnorthEastCorner. For more details about GeoJSON, refer to the RFC 7946 . - The response field
sectionshas changed from an array of section objects to a map of arrays. Each key in the map is a section type and each value is an array of section objects of that type. ThesectionTypefield has been removed from individual section objects. - The response field
startPointIndexin thesectionobjects has been renamed tostartPathIndexand the response fieldendPointIndexhas been renamed toendPathIndex. - The
speedlimitsectionobject has new fields. ThemaxSpeedLimitInKilometersPerHourhas been replaced with thespeedRestrictionslist of objects. Please refer to the API documentation for details about thespeedRestrictionslist of objects. - The query parameter
travelModehas been removed. Please use thetravelModePOST data parameter instead. - The query parameter
vehicleEngineTypehas been removed. Please use thevehicleEngineTypePOST data parameter instead. - The query parameter
arrivalSidePreferencehas been removed. Please use thearrivalSidePreferencePOST data parameter instead. - The
/routing/calculateRouteendpoint has been renamed to/routing/routes/calculate. - The
Attributesrequest header is now required. It specifies which response fields to include using dot-notation. Some response fields are marked as EXPLICIT and must be explicitly listed in this header. See the API documentation for the Response field selection section. - The
Attributes-Excluderequest header is now available (optional). It specifies which response fields to exclude using dot-notation. - The query parameter
routeRepresentationhas been removed.- Please select the desired route representation using the
AttributesandAttributes-Excluderequest headers.
- Please select the desired route representation using the
- The query parameter
sectionTypehas been removed.- Please select the sections as needed using the
AttributesandAttributes-Excluderequest headers.
- Please select the sections as needed using the
- The query parameter
extendedRouteRepresentationhas been removed. - The response
progressobject has been replaced withprogressPoints.- Please select the
progressPointsfields as needed using theAttributesandAttributes-Excluderequest headers. - The fields in
progressPointsdiffer from the previousprogressobject:pointIndexhas been renamed topathIndex.travelTimeInSecondshas been renamed totravelDurationInSeconds.batteryConsumptionInkWhhas been removed.
- Please select the