Routing API Developer's Guide

Enumeration Types

Type
IncidentTypeType

Defines identifiers for different incidents.

Enum [accident, congestion, roadworks, closure, flow, other]

LineStyleType

Line style used to draw a line.

Enum [solid, dotted, dash]
PublicTransportFlagType

Defines a list of special characteristics that may apply to the public transport sections of a route.

Enum [containsTimeEstimate]

  • containsTimeEstimate: The route contains a public transport leg which uses estimated times based on known transit frequency
RouteNoteTypeType

Defines type identifiers for RoutingNote objects.

Enum [info, warning, restriction, violation, traffic]

  • info: Indicates an additional information for the maneuver or the segment leading to the maneuver, like "border crossing", "segment includes tunnel/bridge/toll/unpaved/etc."
  • warning: Indicates a note with warning character, like "sharp curve ahead".
  • restriction: Indicates a note providing additional information about time dependent restrictions on the segment ("road closed during winter").
  • violation: Indicates a note providing additional information about violated routing options, such as route contains tollroads even though it has been requested to avoid tollroads.
  • traffic: Indicates a note providing additional information on traffic.
RouteNoteCodeType

Defines identifiers for RoutingNote objects.

Enum [ copyright, routingOptionViolated, passingPlace, roadNameChanged, sharpCurveAhead, linkFeatureAhead, timeDependentRestriction, previousIntersection, nextIntersection, adminDivisionChange, countryChange, gateAccess, privateRoad, tollbooth, tollroad, unpavedRoad, restrictedTurn, truckRestriction, seasonalClosures, congestion, roadworks, accident, closure, trafficFlow]

  • routingOptionViolated: Indicates that routing options have been violated, in other words, the route contains route features that should have been avoided. The service provides the violated routing feature as text.
  • copyright: Contains copyright notices that must be displayed to the end user when using data provided by Transit Agencies.
  • timeDependentRestriction: Indicates time dependent restrictions for the segment following the maneuver, such as "road closed in winter". The service provides the validity period of this restriction in the corresponding note.
  • previousIntersection: Indicates the name of a previous intersection in a maneuver, such as for indicating the last intersection before arrival. The service provides the name of the intersection along with a descriptive text in the Text field of the corresponding note, such as "The last intersection is Markkulantie"
  • nextIntersection: Indicates the name of a next intersection in a maneuver, such as for indicating the first intersection after arrival. The service provides the name of the intersection along with a descriptive text in the Text field of the corresponding note, such as "If you reach Rantalantie, you've gone too far".
  • adminDivisionChange: Indicates that some part of route crosses administrative division border (state, province, etc.)
  • countryChange: Indicates that some part of route crosses country border.
  • gateAccess: Indicates that some part of route enters or leaves a gated area.
  • privateRoad: Indicates that some part of route runs through a privately owned road.
  • tollBooth: Indicates that some part of route may require a stop at a toll booth.
  • tollRoad: Indicates that some parts of the route are toll roads.
  • unpavedRoad: Indicates that some part of route is unpaved.
  • restrictedTurn: Indicates that some parts of the route may be subject to turn restrictions.
  • truckRestriction: Indicates that some parts of the route violates non-time dependent truck restriction.
  • seasonalClosures: Indicates that one should expect seasonal closures on some part of route.
  • congestion: Indicates that one should expect congestions on some part of route.
  • roadworks: Indicates that there are roadworks expected on some part of route.
  • accident: Indicates that there has been an accident reported on some part of route.
  • closure: Indicates that there is a road closure affecting the route.
  • trafficFlow: Indicates that there is traffic flow (such as sluggish traffic) affecting the route.
HazardousGoodTypeType

Defines names for different types of hazardous materials.

  • explosive: Explosive material
  • gas: Gas
  • flammable: Flammable material
  • combustible: Combustible material
  • organic: Organic material
  • poison: Poison
  • radioActive: Radio-active material
  • corrosive: Corrosive material
  • poisonousInhalation: Materials that are poisonous upon inhalation
  • harmfulToWater: Materials that are harmful to water
  • other: Other types of hazardous materials
  • allHazardousGoods: All types of hazardous materials (response only)
TruckRestrictionPenaltyType

Defines penalty type on violated truck restrictions.

  • strict: route will not use links with a violated truck restriction at any circumstances
    Note: Route computation will fail and return NoRouteFound if not able to avoid the links with a violated truck restriction and the penalty type is strict.
  • soft: route will use links with a violated truck restriction if there is no alternative to avoid them
    Note: The route violating truck restrictions is indicated in the response with dedicated route and maneuver notes. The route with the note of the type violation and the text truckRestriction may be travelled only at own responsibilty. While driving such route extra care has to be taken as it may result in a vehicle or a road infrastructure damage.
PublicTransportActionType

Enumeration to identify different action types needed for public transport maneuvers.

Enum[enter,change, leave]
PublicTransportTypeType

Enumeration to identify different action types needed for public transport maneuvers

Enum[busPublic, busTouristic, busIntercity, busExpress, railMetro, railMetroRegional railLight, railRegional, trainRegional, trainIntercity, trainHighSpeed, monoRail, aerial, inclined, water, privateService]
ResourceTypeType

Defines a list of supported resource type identifiers.

Enum[junctionView, signAsReal, directionArrow, advertising, vendorIcon, vendorLogo, routeTemplate]

  • junctionView: Identifier for the bitmap representing the Junction View
  • signAsReal: Identifier for the bitmap representing the sign-as-real information
  • directionArrow: Identifier for the bitmap representing the direction arrow at a junction. Displayed on top of the junction view
  • advertising: Identifier for the bitmap representing any kind of advertisement
  • vendorIcon: Identifier for the bitmap representing the vendor icon, such as of a public transport system.
  • vendorLogo: Identifier for the bitmap representing the vendor logo, such as of a public transport system
  • routeTemplate: Identifier for the svg resource representing a template for displaying routes (such as highway signs). Clients will have to include the route number in the graphic to display a concrete route sign
DirectionType

Enumeration type to identify directions at a maneuver.

Enum [ forward, bearRight, lightRight, right, hardRight, uTurnRight, uTurnLeft, hardLeft,left, lightLeft, bearLeft]
SideOfStreetType

Enumeration type to identify on which side of a link an object is placed.

Enum [ left, right, neither]
WaypointParameterTypeType

Enumeration type to identify waypoint varieties.

Enum [ stopOver, passThrough]
  • stopOver: 180 degree turns are allowed to continue on the route
  • passThrough: route does not support a break. These points do not appear in list of maneuvers.
    Note: Waypoints defined through a drag and drop action should be marked as passThrough.
PrivateTransportActionType

Describes maneuvers actionable by a private transport vehicle or pedestrian.

Enum [ depart, arrive, leftUTurn,sharpLeftTurn, leftTurn, continue, slightRightTurn, rightTurn,sharpRightTurn, rightUTurn, ferry leftExit, rightExit, leftRamp, rightRamp, leftFork, middleFork, rightFork, leftMerge, rightMerge, nameChange, leftRoundaboutExit1, leftRoundaboutExit2, leftRoundaboutExit3, leftRoundaboutExit4, leftRoundaboutExit5, leftRoundaboutExit6, leftRoundaboutExit7, leftRoundaboutExit8, leftRoundaboutExit9, leftRoundaboutExit10, leftRoundaboutExit11, leftRoundaboutExit12, rightRoundaboutExit1, rightRoundaboutExit2, rightRoundaboutExit3, rightRoundaboutExit4, rightRoundaboutExit5, rightRoundaboutExit6, rightRoundaboutExit7, rightRoundaboutExit8, rightRoundaboutExit9, rightRoundaboutExit10, rightRoundaboutExit11, rightRoundaboutExit12]
  • depart: departure maneuver, such as "Start at"
  • departAirport: departure at an airport maneuver, such as "Start toward the airport exit"
  • arrive: Identifer for an arrival maneuver., such as "Arrive at"
  • arriveAirport: Identifer for an arrival at the airport maneuver, such as "Follow the signs to your terminal"
  • arriveLeft: Identifer for an arrival maneuver with the destination on the left-hand side, such as "Arrive at"
  • arriveRight: Identifer for an arrival maneuver with the destination on the right-hand side, such as "Arrive at"
  • leftLoop: left-hand loop maneuver., such as "Make a left-hand loop onto"
  • leftUTurn: left-hand U-turn maneuver., such as "Make a U-turn at"
  • sharpLeftTurn: sharp left turn maneuver., such as "Make a hard left turn onto"
  • leftTurn: left turn maneuver, such as "Turn left on"
  • slightLeftTurn: slight left turn maneuver., such as "Bear left onto"
  • continue: continue maneuver, such as "Continue on"
  • slightRightTurn: slight right turn maneuver., such as "Bear right onto"
  • rightTurn: right turn maneuver, such as "Turn right on"
  • sharpRightTurn: sharp right turn maneuver., such as "Make a hard right turn onto"
  • rightUTurn: right u-turn maneuver., such as "Make a right U-turn at"
  • rightLoop: right loop maneuver, such as "Make a right-hand loop onto"
  • leftExit: left exit maneuver, such as "Take the left exit to"
  • rightExit: right exit maneuver, such as "Take the right exit to"
  • leftRamp: left ramp maneuver, such as "Take the left ramp onto"
  • rightRamp: right ramp maneuver, such as "Take the right ramp onto"
  • leftFork: left fork maneuver, such as "Take the left fork onto"
  • middleFork: middle fork maneuver, such as "Take the middle fork onto"
  • rightFork: right fork maneuver, such as "Take the right fork onto"
  • leftMerge: left merge maneuver, such as "Merge left onto"
  • rightMerge: right merge maneuver, such as "Merge right onto"
  • nameChange: name change maneuver (no maneuver action needed), such as "Road becomes"
  • trafficCircle: traffic circle maneuver, such as "At the traffic circle take the exit to"
  • ferry: ferry maneuver, such as "Take the ferry to"
  • leftRoundaboutExit1: roundabout maneuver (left-hand traffic), such as "Take the first exit of the roundabout onto"
  • leftRoundaboutExit2: roundabout maneuver (left-hand traffic), such as "Take the second exit of the roundabout onto"
  • leftRoundaboutExit3: roundabout maneuver (left-hand traffic), such as "Take the third exit of the roundabout onto"
  • leftRoundaboutExit4: roundabout maneuver (left-hand traffic), such as "Take the fourth exit of the roundabout onto"
  • leftRoundaboutExit5: roundabout maneuver (left-hand traffic), such as "Take the fifth exit of the roundabout onto"
  • leftRoundaboutExit6: roundabout maneuver (left-hand traffic), such as "Take the sixth exit of the roundabout onto"
  • leftRoundaboutExit7: roundabout maneuver (left-hand traffic), such as "Take the 7th exit of the roundabout onto"
  • leftRoundaboutExit8: roundabout maneuver (left-hand traffic), such as "Take the 8th exit of the roundabout onto"
  • leftRoundaboutExit9: roundabout maneuver (left-hand traffic), such as "Take the 9th exit of the roundabout onto"
  • leftRoundaboutExit10: roundabout maneuver (left-hand traffic), such as "Take the 10th exit of the roundabout onto"
  • leftRoundaboutExit11: roundabout maneuver (left-hand traffic), such as "Take the 11th exit of the roundabout onto"
  • leftRoundaboutExit12: roundabout maneuver (left-hand traffic), such as "Take the 12th exit of the roundabout onto"
  • rightRoundaboutExit1: roundabout maneuver (right-hand traffic), such as "Take the first exit of the roundabout onto"
  • rightRoundaboutExit2: roundabout maneuver (right-hand traffic), such as "Take the second exit of the roundabout onto"
  • rightRoundaboutExit3: roundabout maneuver (right-hand traffic), such as "Take the third exit of the roundabout onto"
  • rightRoundaboutExit4: roundabout maneuver (right-hand traffic), such as "Take the fourth exit of the roundabout onto"
  • rightRoundaboutExit5: roundabout maneuver (right-hand traffic), such as "Take the fifth exit of the roundabout onto"
  • rightRoundaboutExit6: roundabout maneuver (right-hand traffic), such as "Take the sixth exit of the roundabout onto"
  • rightRoundaboutExit7: roundabout maneuver (right-hand traffic), such as "Take the 7th exit of the roundabout onto"
  • rightRoundaboutExit8: roundabout maneuver (right-hand traffic), such as "Take the 8th exit of the roundabout onto"
  • rightRoundaboutExit9: roundabout maneuver (right-hand traffic), such as "Take the 9th exit of the roundabout onto"
  • rightRoundaboutExit10: roundabout maneuver (right-hand traffic), such as "Take the 10th exit of the roundabout onto"
  • rightRoundaboutExit11: roundabout maneuver (right-hand traffic), such as "Take the 11th exit of the roundabout onto"
  • rightRoundaboutExit12: roundabout maneuver (right-hand traffic), such as "Take the 12th exit of the roundabout onto"
ShapeQualityType

Defines identifiers for different types of shape quality. It is not always possible to provide exact geometry of the route which matches map data. This type allows to identify such cases and process them on client side.

Enum [exact,coarse]
  • exact: Shape mostly matches map data with possible rare deviations.
  • coarse: Shape is inaccurate. Typical example can be a route using public transportation where shape only connects subsequent stops.
SourceSupplierNoteTypeType

Defines available types of source supplier notes.

Enum [ticketPurchase]
  • ticketPurchase: Note containing ticket purchase information for public transport data providers, for example description text and direct link to ticket purchasing tool.
  • disclaimer: Note containing disclaimer information from public transport data providers.
RoutingZoneTypeType

Type of the routing zone.

  • vignette: A zone where a vignette is required to use affiliated roads.
  • congestionPricing: A zone of roads where a congestion pricing system applies.
  • adminClass: A zone of roads with a specific administrative class specified by an official transport regulations (often country specific). See also Country Specific Regulations.