The energy use tank-to-wheel in [MJ].

The CO2e well-to-tank in [kg]. This value is only present for conventional fuels with a bio fuel ratio of 0%.

The CO2e tank-to-wheel in [kg].

The CO2 tank-to-wheel in [kg].

The CH4 (methane) tank-to-wheel in [g].

The N2O (Nitrous oxide) tank-to-wheel in [g].

The fuel consumption in [kg]. This value is 0 for vehicle specific conversion factors.

The energy use tank-to-wheel in [MJ].

The CO2e well-to-tank in [kg]. This value is only present for conventional fuels with a bio fuel ratio of 0%.

The CO2e tank-to-wheel in [kg].

The CO2 tank-to-wheel in [kg].

The CH4 (methane) tank-to-wheel in [g].

The N2O (Nitrous oxide) tank-to-wheel in [g].

The fuel consumption in [kg]. This value is 0 for vehicle specific conversion factors.

The left bottom corner of the rectangle. The coordinates are given in the same format as specified in the request.

The right top corner of the rectangle. The coordinates are given in the same format as specified in the request.

Uninterrupted period of time a driver is allowed to drive without a break.

Remark: According to EU regulation : 4h 30min (16200s)

Minimum period of time required for the first break.

Remark: According to EU regulation : 15min (900s)

Minimum period of time required for the second break.

Remark: According to EU regulation : 30min (1800s)

Minimum duration of a required rest break.

Remark: According to NTC_AUS regulation: 15m (900s)

The observation period in which at least one rest break must be done.

Remark: According to NTC_AUS regulation: 5,25h (18900s)

The observation period in which at least two rest breaks must be done.

Remark: According to NTC_AUS regulation: 7,5h (27000 s)

The observation period in which at least four rest breaks must be done.

Remark: According to NTC_AUS regulation: 10h (36000 s)

The array index of the description text or road name of the tunnel or bridge.

The index of the manoeuvre where the bridge or tunnel ends.

The distance from the bridge or tunnel exit to the manoeuvre in [m].

For each input route this array contains an element at the same index containing the results of the route calculation.

If the routing has been executed successfully, this element contains the resulting time and distance of the route. Otherwise this element is nil, and the error attributes contain information on why the routing failed.

If the routing has been executed successfully, this is SUCCESS. Otherwise it contains the error code describing why the routing failed.

If the routing has been executed successfully, this attribute is nil. Otherwise it contains the error message describing why the routing failed.

The average fuel consumption for a fleet in [l/100km] for liquid fuel types or [kg/100km] for gaseous fuel types like COMPRESSED_NATURAL_GAS.

The average fuel consumption for a specific type of route in [l/100km] for liquid fuel types or [kg/100km] for gaseous fuel types like COMPRESSED_NATURAL_GAS.

The actual fuel consumption for this route in [l] for liquid fuel types or [kg] for gaseous fuel types like COMPRESSED_NATURAL_GAS.

Specifies the CEN or other factor-based version for calculating the emissions.

Percentage of biofuel in fuel blend. 0 means no biofuel, 100 means 100% biofuel.

Holder for actual conversion factors.

The emissions based on the vehicle specific fuel consumption. The fuel consumption of the vehicle is set by request or in the vehicle profile.

The emissions based on a fleet specific fuel consumption.

The emissions based on a route specific fuel consumption.

The emissions based on the actual fuel consumption for this route.

The emissions based on the fuel consumption as it was calculated by HBEFA 3.1 or higher. The values based on HBEFA 2.1 will not be correct. If you do not want to calculate emissions based on HBEFA, use HBEFAVersion NO_HBEFA.

The energy and emission conversion factors. If the fuel type supports blends with biofuel, three items are provided in this order (duplicates may occur if the actual fuel blend contains 0% or 100% biofuel):

• the actual fuel blend (available for all fuel types)
• 0% biofuel (EUROSUPER and DIESEL only, not for CO2_DECREE_FRANCE_2011)
• 100% biofuel (EUROSUPER and DIESEL only, not for CO2_DECREE_FRANCE_2011)

Only filled if CENVersion does not equal CEN_2011.

The energy use tank-to-wheel in [MJ].

The energy use well-to-wheel in [MJ].

The CO2e well-to-wheel in [kg].

The energy use for tank-to-wheel calculation in [MJ].

The energy use for well-to-wheel calculation in [MJ].

The energy use for well-to-tank calculation in [MJ].

The CO2e well-to-wheel calculation in [kg].

The CO2e well-to-tank calculation in [kg].

The fuel consumption in [kg]. This value is 0 for vehicle specific conversion factors.

The CO2 well-to-wheel value in [kg].

The CO2 well-to-tank value in [kg].

The CO2e well-to-wheel value in [kg].

The CO2e well-to-tank value in [kg].

The departure time of the current time step, which is equal to route_start_time + dynamic_step_size * current_step_index.

This attribute may be omitted for matrix calculation (see MatrixOptions ).

The travel time for this departure time in [s]. If -1, the travel time could not be calculated due to a blocked road segment.

An array of the detailed toll information per toll section. The array might be null if the corresponding option is not set.

The integration unit code.

Summary information about distance and time, based on the total route. Additionally the cost field of the RouteInfo Object holds the toll distance.

Information about distance and time per network class.

Additionally the cost field of the RouteInfo object holds the toll distance. Please note that these distances may differ in some countries (e.g. Germany) from perTypeTollDistance as they are based on the routing calculation and not on the official distance tables provided by the government, which are not available per network class.

An array of toll distances based (in [m]) on the toll types in the same order of the attributes in the TollType Enumeration (for example city toll, charge for ferry).

These values are currently incomplete. In order to obtain the correct toll distance, sum up the values contained in perNCRouteInfo.

The first entry is associated with the common aggregation SPECIALCHARGE containing the summary of all kind of special charge toll types.

In some countries (for example Germany) these distances may differ from those stated in perNCRouteInfo as they are calculated from official distance tables provided by the governements.

Array of toll prices based on the toll types in the same order of the attributes in the TollType Enumeration (for example city toll, charge for ferry).

The price is given in subunits of the currency. For example if currency is Euro, the price is given in Eurocents. If the currency consists of 1000 subunits, the price is given in 10 subunits.
The first entry is associated with the common aggregation SPECIALCHARGE containing the summary of all kind of special charge toll types.

The currency of the toll prices. Deprecated, use attribute currencyISOCode instead.

The currency name of the requested language in case there is toll data for this country available.

This is an optional attribute and is only set if 'currencyDescription' in CountryInfoOptions is true.

The ISO 4217 code of the currency in case there is toll data for this country available.

This is an optional attribute and is only set if 'currencyDescription' in CountryInfoOptions is true.

The optional country code information. If the RoutingParameter COUNTRY_ENCODING is not set, this attribute does not exist.

An additional information string in the desired language. If this language does not exist, the info will be given in english.

The unique key to identify the toll scenario that was used for this country. This attribute is optional. It is returned if tollDate or tollScenarios in CountryInfoOptions are set. In case of scenarioId 1001 there is no toll at all in this country.

If these toll data are named, and CountryInfoOptions attribute named toll is 'true', this attribute contains the toll name.

This attribute holds the toll totals for this country (distance and cost). By default this value is null. To enable it, CountryInfoOptions attribute tollTotals must be set to 'true'.

This attribute holds a percentage value for the namedToll for this country. By default this value is null. To enable it, CountryInfoOptions attribute costsPercentageToPassOn must be set to 'true'.

Presently this value is available for France only. It is part of the french ecotaxe regulations.

The IDs of the different reductions.
Legal values are the values from the list of reductiontype found in the map-directory after first start of the PTV xRoute Server.

ReductionIDs are not supported yet.

If true, detailed toll costs (see TollCostInfo) per country are generated.

If true, all prices will be returned in Euro. Otherwise all prices will be returned in its currency. All of the costs are calculated in decimal amounts.

Sets toll scenarios for different countries. This setting overwrites values set by tollDate.

The underlying map may contain different toll scenarios for each country. These scenarios are valid from a specified date. If toll date is set, xRoute will use the according scenario for each country, otherwise the start time of the routing will be used (see START_TIME of RoutingParameter). The toll date must be specified as a string using the xsd:datetime syntax as for example 2018-01-01T09:00:00-01:00. Individual scenarios can be overwritten with the attribute tollScenarios.

The scenarios can be found in the file TollScenarios.ini in your map path (if available). The first column specifies the scenario id. The second column represents the country ID and the 7th column 'VALIDFROM' defines the starting date for this scenario given in the form YYYYMMDD.

If true, the optional attribute 'partTollCosts' in ExtendedRoute will be returned.

If true, more detailed toll calculation with named toll is activated. The CountryInfo Response Object will return the additional TollTypes NATIOALNAMEDTOLL, NATIONALSECTIONBASED and NATIONALDISTANCEBASED.

PartTollCost response objects do not contain the more detailed TollTypes.

If true, the calculation of toll totals is activated. For example the toll distance and toll costs per country. See CountryInfo element tollTotals.

If true, the optional attributes 'currencyISOCode' and 'currencyName' in CountryInfo and TollCost will be returned.

If true, the field waypointIndex in TollCostInfo is filled in the response.

If true, the calculation of the costsPercentageToPassOn is activated. See CountryInfo attribute costsPercentageToPassOn.

A single vehicle option.

Regular daily rest period.

First period of a split regular daily rest period.

Second period of a split regular daily rest period.

Reduced daily rest period.

Number of allowed reduced rest periods between any two weekly rest periods.

Regular daily driving period.

Extended daily driving period.

Maximum number of extended driving periods per week.

Note: The maximum allowed value is 2, larger values are not accepted.

Within each of this period after the end of the previous daily rest period a driver shall have taken a new daily rest period.

Minimum duration of a required daily rest.

Remark: According to NTC_AUS regulation: 7h (25200 s)

Maximum working period which cannot be exceeded in one day (24h).

Remark: According to NTC_AUS regulation: 12h (43200 s)

The radius around the starting or destination station in [m] where to generate the RouteDescription in the requested detail minDetail.

The minLevel to generate in the start or destination area.

Periods and frequencies needed to obey the weekly rest rules of the European Union.

Parameters needed to obey the working rules of Germany.

Parameters needed for breaks and break intervals.

After a driving period a driver shall take an uninterrupted break of at least the break period.

The Australian Heavy Vehicle Driver Fatigue Legislation sets out minimum rest and maximum work hours. In case of the BreakRuleAUS the maximum work hours are equal to the maximum observation period minus the break period.

Stores all periods needed to obey the Australian daily rest rule.

Stores all periods needed to obey the Australian weekly rest rule.

Encoded remaining periods of a driver's previoius tour. If this value is set, the regulations in TourOptions must be set to null, because remainingPeriods contain the DriverRegulations from a previous tour and can not be changed.

If true, the break rule (EU) is disabled.

If true, the daily rest rule (EU) is disabled.

If true, the weekly rest rule (EU) is disabled.

If true, the rule for working hours (EU) is disabled.

If true, the break rule based on NTC_AUS is disabled.

If true, the daily rest rule based on NTC_AUS is disabled.

If true, the weekly rest rule based on NTC_AUS is disabled.

The time benefit in [s] you will haven when taking the dynamic route in contrast to the travel time on the static route including traffic jams.

timeBenefit = Td(Rs) - Td(Rd)

In case of a road blocking on the static route according to a dynamic traffic incident, Td(Rs) is not defined. In this case timeBenefit is set to -1.

The time loss in [s], when taking the dynamic route in contrast to the static route. timeLoss = Td(Rd) - Ts(Rs).

The time loss in [s], when taking the static route despite of traffic jams in contrast to the static route without traffic jams.

timeLoss2 = timeBenefit + timeLoss = Td(Rs) - Ts(Rs)

In case of a road blocking on the static route according to a dynamic traffic incident, Td(Rs) is not defined. In this case timeLoss2 is set to -1.

The distance difference between the dynamic and the static route in [m].

This is an optional attribute and is only set if the REQUEST_VERSION is set to 1.4.5 or higher.

Defines at which level to return the emissions of the route.

hydrocarbons, total in [g].

methane in [g].

hydrocarbons except for methane in [g].

carbon monoxide in [g].

carbon dioxide in [kg] (total value).

sulphur dioxide in [g].

nitrogen oxides in [g].

nitrous oxide in [g].

ammonia in [g].

benzene in [g].

toluene in [g] (only HBEFA_2_1).

xylene in [g] (only HBEFA_2_1).

lead in [g].

particular mass in [g].

petrol/fuel in [kg].

nitrogen dioxide in [g].

carbon dioxide from fossil sources in [kg] (this value depends on the country-specific shares of biofuels).

particle number.

nitrogen dioxide in [g].

carbon dioxide from fossil sources in [kg] (this value depends on the country-specific shares of biofuels).

particle number.

An array of nodes specifying a route path. All nodes have to be connected.

Alternative description representing a route path (optional).
This is an external representation consisting of a list of provider's segment ID's (for example HERE).

The syntax for this description is:
LINESTRINGSEG(<segID> <dir> <countryCode>[,<segID> <dir> <countryCode>]*)

<segID> = provider ID
<dir> = the digitalization direction
<countryCode> = the countryCode representing the country the segment belongs to

Example:
LINESTRINGSEG(78620413 0 49,540932189 1 49,540933595 1 49)

The SegmentIDs of certain countries will only be taken into account when the corresponding IDMapping layer could be initialized. See the list of countries in the logging, initialized when xRoute Server is started.

Alternative description representing an optional list of segments which match certain street names resp. street numbers.

The list of segments includes all segments which match at least one of the street names resp. street numbers.

The syntax for this description is:

<streetname>[/<streetname>]*

absTimeMalus will be ignored if this attribute is non-empty, instead relMalus will be considered.

If more than one ExceptionPath elements contain a non-empty 'street' attribute, only the last occurrence will be considered.

calculateMatrixInfo() does not support this attribute.

Binary description representing a route path (optional) useful for alternative routing and traffic information. The binary path description string can be requested with each route.

This is an internal format returned by a route calculation which is dependent on the map currently used. Therefore, it will become invalid when a map update is performed.

Each binary path description will be checked against the map currently in use. An error will be thrown if the check fails. To increase performance the key router.exceptionPath.disableBinaryPathCheck can be modified, but make sure that all binary path descriptions are correct. Sending incorrect values will make PTV xRoute Server behave non-deterministically.

The malus or bonus value in percent which has to be added to the base cost value.

Legal values are -99 to 2501.

• <0: Bonus (the minimum value -99 will reduce the cost value to a minimum, for example the road segments are preferred)
• =0: No change (Default)
• >0: Malus (the maximum value 2501 is interpreted as road segments blocked)

An absolute malus in [s]. If < 0: the absolute value will be added for each segment of the entire path (example: a value of -10 will add 10 seconds to each segment of the path). If > 0: the absolute value will be distributed equally for all segments of the entire path. For example: a value of 10 will add 10 seconds to the complete path. This is useful for adding time due to traffic jams.

If the absolute time malus is set and does not equal 0, relMalus will be ignored.

An alternative representation of a route path (optional). The polyline will be linked to the road network internally.

Intelligent road matching will not be executed, therefore the result might not always meet the requirements of the user. To obtain best results, the polyline's points must be close to each other and they must match the coordinates of the road data of the configured map exactly. GPS traces are not a proper input. Ferries cannot be matched and will not be considered.

Only a relative malus of -99 is allowed. In order to calculate a route from A to B using a polyline exception path p1,...,pn, execute the following two requests. First, calculate a route from p1 to pn and set the polyline exception path with malus -99, and set the ResultListOption binaryPathDesc to true. Then calculate the route from A to B using the resulting binaryPathDesc representation from the previous request with the required malus.

For long routes the computation will take some time, therefore the length of the polyline is limited by default. Please refer to the parameter router.exceptionPath.polylineMaxLength in xroute.properties.

A representation of an exception path (optional). It contains all segments that intersect with the given line. The line must be specified by exactly two points. Note that the intersection of a segment with the given line is calculated based on the two end nodes of the segment, the additional intermediate points to represent curved segments are not considered here. 

Horizons to respect during the expansion when calculating reachable objects (only one allowed) or isochrones (one or more allowed). The horizons must be given in [s] or [m] according to the expansion type. If several horizons are given, the horizons have to be in increasing order.

The type of the expansion for calculation of isochrones and reachable objects.

The linking time in [s] between matchCoord and locationCoord.

The linking distance in [m] between matchCoord and locationCoord.

The angle of the outgoing road of the manoeuvre relative to the incoming road in [deg] (counterclockwise).

The angle of the outgoing road of the manoeuvre related to north in [deg] (clockwise).

The turn weight of the manoeuvre.

The turn orientation of the manoeuvre.

The manoeuvre type.

The index of the RouteListSegment to which the waypoint is linked.

The manoeuvre description text in the requested route language (see RoutingOptions).

An array of country information based on the waypoint list.

This array holds an instance of PartTollCosts for each part of the route. A part is the route between two waypoints. This attribute is returned if 'calculatePartTollCosts' in CountryInfoOptions is set to 'true'. Otherwise it is null.

The detailed route description.

The theme ID. Please refer to the documentation about the feature layer data.

Time domain where the related feature is valid for. Please refer to the time domain documentation.

This attribute is empty if the related feature is unrestricted as far as the validity period is concerned.

For further information refer to the documentation about the feature layer data.

Defines which HBEFA version should be used for emission calculation. Default is HBEFA 2.1.

Beside HBEFA there can also be configured the emission calculation COPERT for Australia.

Interval start.It must be specified as a string using the xsd:datetime syntax as for example 2018-01-01T09:00:00-01:00.

The IsochroneInfo for each horizon given in the request. The array index of the IsochroneInfo-array corresponds to the array index of the horizon-array in the request.

An additional information. If no additional information is available, this attribute does not exist.

The polygon specifying the isochrone for a certain expansion horizon.

The segments within a certain expansion horizon representing the isochrone. Each IsochroneSegment object belongs to exactly one certain horizon. This means if there are several horizons, the sets of IsochroneSegments for different horizons are always disjunct (see figure).

The horizon to which this IsochroneObject corresponds to, in [s] or [m] according to the expansion type of the request.

The expansion description for the isochrone calculation.

Describes the detail level of the calculated isochrone (surrounding polygon, corresponding segments, or both).

Describes the calculation mode for the surrounding polygon of the isochrone.

The segmentID this IsochroneSegment corresponds to. The segment is always given in digitalization direction (segmentID[0] to segmentID[1]). The driving direction is given by the attribute direction in combination with the digitalization direction.

If true, the driving direction is equal to the digitalization direction. Otherwise the driving direction is against to the digitalization direction.

The distance driven on the segment up to the isochrone border for the given horizon in [m] relative to the start of the segment.

The time needed on the segment up to the isochrone border for the given horizon in [s] relative to the start of the segment.

The distance driven on the segment up to the isochrone border for the given horizon in [m] relative to the sink point.

The time needed on the segment up to the isochrone border for the given horizon in [s] relative to the sink point.

If true, the manoeuvre is located at a border.

If true, a toll road starts at this manoeuvre.

If true, a toll road ends at this manoeuvre.

If true, a temporarily blocked road starts at this manoeuvre.

If true, a temporarily blocked road ends at this manoeuvre.

If true, the manoeuvre for entering an urban area.

If true, the manoeuvre for leaving an urban area.

If true, a tunnel or a bridge starts at this manoeuvre.

If true, a tunnel or a bridge ends at this manoeuvre.

The index of the first RouteManouevre belonging to this ManoeuvreGroup.

The index of the last RouteManouevre belonging to this ManoeuvreGroup.

The type of this ManoeuvreGroup.

A rectangle describing the spatial extension of this ManoeuvreGroup. The coordinates are given in the same format as specified in the request.

The array of RouteInfo elements. The array has the size of NxM elements where N is the number of startwaypoints and M the number of destWaypoints a certain RouteInfo relation element [x,y] can be accessed by matrixInfo[x*M+y]. Values of -1 in matrixInfo[n] mean that this route has not been calculated due to a user abort.

A filter to use in matrix calculation. The filter gives an array of 7 boolean values representing a switch for each possible network class. For example if in a certain calculation only the highway distances are requested, the filter has to be set to [1,0,0,0,0,0,0].

If true, only the parts of the route having a so called toll flag for the requested vehicle type will be summed up in the MatrixInfo.

The exception paths to respect when calculating these routes. For example to calculate alternative routes or consider traffic information.

If set to false, the Calendar object representing the departure time for each travelTrend step is excluded from the response.

The default value is true, but for larger matrixes we recommend setting this parameter to false.

The speed in [km/h]. If normSpeedType = STATIC, this value is equal to vCalc. If normSpeed = FREE_FLOW, this value contains the maximum speed which would be possible driving if there was no traffic disturbance. If normSpeed = MAX_DYNAMIC, this value contains the maximum dynamic speed contained in the dynamic data. In the latter cases vCalc is likely to be less than normSpeed.

The speed type.

The toll distance for this part in [m].

An array of different TollCost objects.

The reach info for each location given in the request. The array index of the reachInfo-array corresponds to the array index of the location-array in the request.

An additional information. If no additional information is available, this attribute does not exist

If true, the location is reachable within a certain time or a certain distance horizon.

The time [s], distance [m] and costs (for internal purposes) needed to reach a certain location. If the location cannot be reached, distance, time and costs are set to -1.

The unique key to identify the node from which the shortest path to a certain location starts. If the location is not reachable, the branchNode object is set to NULL.

The time and distance needed to reach the object.

The unique key to identify the node from which the shortest path to a certain location starts.

The unique key to identify the object and coordinates.

The unique key to identify the object.

The reachable objects.

the expansion description for the reachable objects calculation (only one horizon is allowed).

The geodatasource which contains the objects to be searched for. See RoutingParameter GEODATASOURCE_LAYER for details. This option can be empty in order to search only within the additional objects.

The link type for the reachable objects. FUZZY_LINKING is not allowed here. If empty, NEXT_SEGMENT will be used.

The routing direction. If FORWARD, all objects reachable from the sink or the route within the given horizon are calculated. If BACKWARD, all objects which can reach the sink or the route within the given horizon are calculated.

Contains additional objects which will be considered when searching for reachable objects.

Maximum number of bounding boxes used for querying POIs from the database.

xRoute fetches a list of POIs from the database before each of these POIs is tested for reachability within the given distance (see expansionDesc). Therefore minimizing the number of POIs by using good bounding boxes increases the performance of the searchForReachabelObjects method. xRoute will determine the bounding boxes on the basis of a smart algorithm. The boundingBoxCount is just an upper bound for this algorithm and will in most cases not be reached.

If this attribute is not set, a default of 200 is assumed. Depending on the database and the spreading of the POIs, it might increase the performance of the request if this attribute is set to a higher value.

If true, manoeuvres are generated.

If true, texts are generated.

If true, node infos are generated.

The array of nodes specifying the route trajectory can be taken as an exeptionPath in the appropriate input parameter list. For example when calculating an alternative route.

If true, the binary path description is generated.

The binary path description specifies the route trajectory and can be taken as an exeptionPath in the appropriate input parameter list. For example when calculating an alternative route.

This is an internal format returned by a route calculation which is dependent on the map currently used. Therefore, it will become invalid when a map update is performed.

If true, the polyline representing the route will be generated.

If true, the polyline representing the route will contain the z-coordinate which contains the approximate elevation at that location. This features requires the file heights.bin to be available in the map root directory. This parameter is only interpreted if polygon is true.

Specifies which detaillevel is generated.

If true, optional travel time information is generated (in case of dynamic routing).

This parameter is only interpreted if RoutingParameter ENABLE_DYNAMIC is true.

If true, segmentinfo is generated.

If true, segment attributes are generated. This parameter is only interpreted if segments is true.

If true, segment attributes distinguish between ferry and piggyback. See SegmentAttributes for details. This parameter is only interpreted if segmentAttributes is true.

If true, the segment attribute hasNamedToll will be returned in the response. See SegmentAttributes attribute hasNamedToll.

This parameter is only interpreted if segmentAttributes is true.

If true, manoeuvre attributes are generated.

This parameter is only interpreted if manoeuvres is true and brunnelManoeuvres or urbanManoeuvres is true.

If true, brunnel manoeuvres are generated.

This parameter is only interpreted if manoeuvres is true.

If true, urban manoeuvres are generated.

This parameter is only interpreted if manoeuvres is true.

A special detail level in a certain start region (additional).

A special detail level in a certain destination region (additional).

If true, minimaps are generated.

Optional value representing the height/width ratio of the ManoeuvreGroup.extend representing the bounding rectangle.

If the ratio is 1, height and width are equal.

This parameter is only interpreted if manoeuvreGroups is true.

If true, toll manoeuvres are generated.

This parameter is deprecated from version 1.26.0 on. Toll manoeuvres are always generated.

Defines if and how much bounding rectangles for the route are returned.

If the count is set to 0, no bounding rectangles are calculated.

Legal values are > 0 if the value is greater as the max number of polypoints for this route.

max number of polypoints -1 bounding rectangles are calculated

Default is 0

Defines whether bounding rectangles should be expanded by a certain value in [m].

Legal values are > 0

Default is 100

This parameter is only interpreted if boundingRectanglesC > 0.

If true, the total bounding rectangle for this route is calculated.

If true, the external segment ID representation of the route path is returned (see Route.extSegments).

The SegmentIDs of certain countries will only be taken into account, when the corresponding IDMapping layer could be initialized. (see logging of the list of countries initialized when xRoute Server is started).

If true, the emissions of the route are returned. The emission calculation depends on the vehicle parameters used for the toll calculation. That is stated in this request or the profile used (see VehicleParameter). Make sure that the request and profile state all of the necessary vehicle parameters, otherwise the default values are used. For some vehicles emission data is not available. The segment information are only returned if the parameter segments is true. This parameter is not evaluated when calling calculateRoute as this method does not have any vehicle parameters.

Specifies which data is used for the emission calculation. If not specified, HBEFA 2.1 is used.

This attribute must be set, to return factor-based emission values, for example based on the European norm EN16258 (CEN) or NGA in Australia.

If true, speed limits are returned. See SpeedLimit for details.

This parameter is only interpreted if segments is true.

If true, feature descriptions are returned. See FeatureDescription for details.

This parameter is only interpreted if segments is true.

If true and the PTV_TimeZones FeatureLayer is present, UTC offsets (in minutes) are returned for segments and stations.

The summary information about distance and time.

The optional travel time information in case of dynamic routing.

The array of the start, destination and via station descriptions.

The array of manoeuvres to be performed. The array might be null if ResultListOptions for manoeuvres are set to false.

An array of strings representing the string pool needed for this route. The array might be null if ResultListOptions for Texts are set to false.

An array of RouteListSegments representing the segment information for this route. The array might be null if ResultListOptions for segments are set to false.

An array of UniqueGeoID's representing the nodes information for this route. The array might be null if ResultListOptions for nodes are set to false. The array of nodes describing the route trajectory can be taken as an exeptionPath in the appropriate input parameter list when calculating an alternative route for example.

A LineString object representing the polygon for this route, the actual waypoint coordinates are not included, but the match coordinates instead. The LineString Object might be null if ResultListOptions for polygons are set to false.

Describes the route path in a binary internal format. This is only because of a compact route path description when calculating alternative routes (see ExceptionPath).

An array of ManoeuvreGroups representing the extent of a ManoeuvreGroup

the array might be null if ResultListOptions for ManoeuvreGroups are set to false

An array of BoundingRectangle representing the bounding rectangles around the calculated route. The array might be null if boundingRectanglesC in ResultListOptions are set to 0.

Qn array of BoundingRectangle representing the bounding rectangles around the calculated route. The array might be null if boundingRectanglesC in ResultListOptions is set to 0.

Alternative description representing the route path (optional). This attribute is only set if the corresponding (optional) RouteListOption.extSegments is set to true AND at least one segment ID could be determined (see NOTE below).

This is an external representation consisting of a list of provider's segment IDs (for example HERE).

The syntax for this description is:

LINESTRINGSEG(<segID> <dir> <countryCode>[,<segID> <dir> <countryCode>]*)

<segID> = provider ID
<dir> = the digitalization direction
<countryCode> = the countryCode representing the country the segment belongs to

Example:
LINESTRINGSEG(78620413 0 49,540932189 1 49,540933595 1 49)

NOTE: The SegmentIDs of certain countries will only be taken into account when the corresponding IDMapping layer could be initialized. (see logging of list of countries initialized when xRoute Server is started)

The emission of various substances for the complete route. The linking distance will not be considered.

The vehicle related average emissions per kilometer are independent of the route. They only depend on the vehicle properties such as type or weight; they do not depend on the speed or inclination. This element will be returned for HBEFA 3.1 calculations only!

The CEN or other factor-based emissions for this route. The linking distance will not be considered.

Travel distance in [m] (includes link distance).

Negative values show error codes.

Travel time in [s] (includes link time)

NOTE:

1) This time includes waiting times if the calculateTour method is used.

2) In case of a road blocking on the static route the dynamic time on static route resp. Td(Rs) is infinite.

If so parameter time is set to -1 provided that DYNAMIC_TIME_ON_STATICROUTE is set to 'true'.

3) Otherwise negative values show error codes. Most common error codes here are -3120: At least one of the stations in the linking request could not be linked to the road network (coordinates might be outside of the map, far away from streets or close to streets which cannot be used for routing such as pedestrian zones, wood-paths and so on). -3211: No valid route found, one of the stations is located in an isolated area, or there is no route for the given restrictions, check the routing restrictions. Furthermore, -3211 is issued when this relation has not been calculated due to request abort.

The cost of the calculated route according to the given objective function. Unless stated otherwise in the referencing element this value contains a mathematical value rather than a monetary value, negative values show error codes.

The travel trend for commuters. This element is only present if the travel trend for commuters was requested (for example DYNAMIC_TRAVEL_TIME_STEP_COUNT > 1).

If true, the route has violations. A route can only have violations if violations have been explicitly enabled. For details see RoutingParameter ALLOW_SEGMENT_VIOLATIONS.

The index of the first point in the polygon array belonging to this segment. If no polygons have been returned, the index is -1.

The number of polypoints belonging to this RouteListSegment starting with firstPolyIdx.

The index of the first node in the nodes array belonging to this segment. If no nodes have been returned, the index is -1.

The number of nodes belonging to this RouteListSegment starting with firstNodeIdx.

The index of the Text representing the streetnumber in the texts array belonging to this segment. If no texts have been returned, the index is -1.

The index of the text representing the StreetName in the texts array belonging to this segment. The index is -1 if no texts have been returned.

The index of the text representing the SignName in the texts array belonging to this segment. The index is -1 if no texts have been returned.

The accumulated time in [s] up to the endpoint of the segment (might include waiting time at a station on this segment, except for the last station). When using the calculateTour service, the time comprises service, break, and rest at a station on the segment. The last segment ends at the last station and does not comprise a service period there.

The accumulated distance in [m] up to the endpoint of the segment.

The networkclass of this segment.

The normalized speed value in [km/h] classifying the segment as slow or fast segment. This is not the exact speed value taken in route calculation, but gives the relative speed of this segment in contrast to all other segments (DEPRECATED, always 0).

Describes the maximum speed on the route segment in [km/h]. Only if RoutingParameter SPEED_INFOS is true. Please note that this is not the speed limit.

The calculated speed on the route segment in [km/h]. Only if RoutingParameter SPEED_INFOS is true.

For more information on speed values, please refer to the speeds documentation.

the integration unit code of the country this segment belongs to

This group of output attributes is only set if it is requested in the RouteListOptions.

The optional country code information. If the RoutingParameter COUNTRY_ENCODING is not set, this attribute does not exist.

The emission of various substances for the segment.

The CEN emissions for this segment..

The speed limits valid for this segment.

The blocking segment violations of the segment. The violations are returned in an array. Each violation is composed as follows:

<ScopeType>:<Text of specific violation>

NetData:Blocks Trucks

A list of feature descriptions valid for this segment. To receive this attribute the featureDescriptions attribute of ResultListOptions has to be set to true.

Extra map data is needed to use this result attribute.

The UTC offset (offset from Coordinated Universal Time +/-) is the difference in minutes from Coordinated Universal Time (UTC) at the endpoint of this segment. It includes the DST (Daylight saving time) if required for this segement. This attribute is optional and is only returned if 'utcOffsets' in ResultListOptions is set to true.

The angle of the outgoing road of the manoeuvre relative to the incoming road in [deg] (counterclockwise).

The angle of the outgoing road of the manoeuvre related to north in [deg] (clockwise).

The turn weight of the manoeuvre.

The turn orientation of the manoeuvre.

The exit number when the manoeuvre is located at a roundabout.

The manoeuvre type.

The detail level to which this manoeuvre belongs to.

The type of the direction info at this manoeuvre.

An array-index of the direction info text.

The type of the location info at this manoeuvre.

The array-index of the location info text.

The index of the corresponding RouteListSegment.

The array index of the preceding RouteListSegment RouteManoeuvre.

The array index of the succeeding RouteListSegment.

The manoeuvre description text in the requested route language (see RoutingOptions).

Optional manoeuvre attributes. This group of output attributes is only set if it is requested in the RouteListOptions and if at least one of the attributes is set.

Optional manoeuvre description for manoeuvres generated when entering or leaving a city. This group of output attributes is only set if it is requested in the RouteListOptions and if at least one of the attributes is set.

Optional manoeuvre description for manoeuvres generated when entering or leaving a tunnel or a bridge (brunnel). In this case a manoeuvre after a tunnel can refer to a tunnel or a bridge just passed, for example: bear right 100 meters after the bridge. This group of output attributes is only set if it is requested in the RouteListOptions and if at least one of the attributes is set.

An array-index of the corresponding ManoeuvreGroup.

An array-index of the corresponding WayPoint.

-1 if there is no direct corresponding WayPoint.

This index always points to the WayPoint just passed.

The WayPoint is located between this and the previous manoeuvre except this is the last manoeuvre. In this case the WayPoint is located after this manoeuvre.

The routing option to be set.

The according value for the routing option. Legal values depend on the RoutingParameter.

Describes if this segment belongs to a tunnel or bridge and describes the type.

If true, this segment represents a ferry, otherwise a piggyback train connection.

If ResultListOption segmentAttributePiggyback is true, this attribute is true only if the segment represents a ferry. Otherwise (default) this attribute is true if the segment represents a ferry or a piggyback.

If true, this segment is blocked for cars.

If true, this segment is blocked for trucks.

If true, this segment is a toll road for cars.

If true, this segment is a toll road for trucks.

If true, this segment is a vignette road for cars

If true, this segment is a vignette road for trucks.

If true, this segment has extra toll.

If true, this segment has named toll.

This attribute is only present if ResultListOption segmentAttributeNamedToll is true. Otherwise (default) this attribute is not present.

If true, the road of this segment has a divider (is currently always false).

If true, the road of this segment is a pedestrian zone.

Indicates optional road editor information given as semicolon separated key-value pairs according to the RoadEditor properties set for the corresponding segment in the additional road editor database.

Possible keys are given in RoadEditorOptions

If no road editor information is requested, this attribute does not exist.

Example:

<< key1|dir1 >>=<>,<< key2|dir2 >>=<< value2 >>,...,<< keyn|dirn >>=<< valuen >>

dir = 0, the segment is given in opposite direction

dir = 1, the segment is given in driving direction

EXT_INFO|0=1,IS_RAMP|1=1,OPT_MALUS1|1=-50

Represents optional additional - not documented - Information for project purposes.

The low emission zone is presented by one of the these identifiers:

• 0      (NO low emission zone)
• 1       (GREEN low emission zone)
• 2       (YELLOW low emission zone)
• 3       (RED low emission zone)

Describes if this segment represents a piggyback.

This attribute is only present if ResultListOption segmentAttributePiggyback is true. Otherwise (default) this attribute is not present.

The speed limit itself in [km/h].

The condition under which the speed limit is valid.

The array of speed limits.

The type of event.

The start time of the event which might become negative if remaining driving times are given and the current tour does not follow the previous one immediately. The time in-between can then be used for a break or a rest.

The period of the event.

The zero-based index of this event in the tour point array of the Tour element.

The zero-based index of this event in the stations array of the Route element. This is particularly interesting if the event does not occur at a tour point but on the road instead. The segment index of the last tour point is invalid as there is no segment beginning at the last tour point.

The cost.

The currency of the toll prices. Deprecated, use attribute currencyISOCode instead.

The ISO 4217 code of the currency in case there is toll data for this country available.

This is an optional attribute and is only set if 'currencyDescription' in CountryInfoOptions is true.

The currency name of the requested language in case there is toll data for this country available.

This is an optional attribute and is only set if 'currencyDescription' in CountryInfoOptions is true.

The integration unit code .

The type of the toll.

If tollSectionID does not equal -1, this element contains information on the start point of this toll section.

If tollSectionID does not equal -1, this element contains information on the end point of this toll section.

ID for the toll section. -1 if this country has global toll (vignette).

The name for the toll section according to the sectionID. Empty if this country has global toll (vignette).

This is an optional attribute and is only set if the REQUEST_VERSION is set to 1.4.5 or higher

ID for the toll company.

The toll provider name according to the providerID.

This is an optional attribute and is only set if the REQUEST_VERSION is set to 1.4.5 or higher.

The street name. This is an optional attribute and is only set if the REQUEST_VERSION is set to 1.4.5 or higher.

Distance of the toll section in [m].

Price for the toll section (can be 0 for citytoll/vignette in case of reentering). The price is given in subunits of the currency, for example if currency is Euro, the price is given in Eurocents. If the currency consists of 1000 subunits, the price is given in 10 subunits.

Kind of the toll section (for example national toll or extra toll).
The TollType parameter also includes all kind of special charge toll types, except for the common aggregation SPECIALCHARGE.

For internal use only.

This is an optional attribute and is only set if the REQUEST_VERSION is set to 1.4.5 or higher.

The currency of the toll prices. Deprecated.

Represents the currency description.

This is an optional attribute and is only set if the REQUEST_VERSION is set to 1.4.5 or higher.

Index of the waypoint to which this toll section is assigned to. This value is only filled if the CountryInfoOptions.waypointIndexInTollCostInfo is set to true in the request.

The integration unit code for this scenario.

The unique key to identify the scenario.

The name of the toll station.

The identifier of the toll station.

Type of the location info at this toll station.

The index in the routelist where this tollsection starts or ends. It has the value -1 if there is no toll station. This is for countries in which the toll depends on the distance.

The time String representing the time for entering or leaving the according toll section.

This is an optional attribute and is only set if the REQUEST_VERSION is set to 1.4.5 or higher.

Optional attribute describing the manoeuvre type. Is either ENTER, EXIT, FURTHER or CHANGE.

The total toll distance within a country in [m]. This value indicates the distance given by the toll provider.

The total toll costs within a country.

The tour points.

The list of events occurred during the tour.

The tour summary.

This value must be set to null if remainingPeriods in driverSettings are set, because remainingPeriods contain the DriverRegulations from a previous tour and can not be changed.

By default, the regulations of the EU as described in DriverRegulations will be active.

The arrival time at this tour point.

Start of service.

End of service.

The departure time.

The zero-based index of this tour point in the stations array of the Route element.

If true, the tour could not be calculated matching all parameters. Arrival (and complete service if needed) is not within the opening intervals.

If true, the tour could not be calculated matching all parameters. The complete service period is not within the opening intervals.

The service period at this tour point in [s].

The opening intervals at this tour point. The route will be calculated in a way so that arrival (and the service period if need be) will be within the opening intervals. The intervals must be disjunct, ascending and they must end after the start of the route. This element can be nil, in that case arrival can be anytime.

If true, the driver must not help unloading a truck. If set to false, it can be assumed that the driver has to work during the whole service period. If set to true, the driver for example waits while someone else unloads the truck. This means if the service-period is longer than the minimum period required for a break, the driver can use the service period as a break (or rest).

If true, arrival and complete service period must be within the opening intervals, otherwise only arrival must be within.

End of the service at this tour point. If the Site-ID is == Constants::UNDEFINED_SITE_ID(), the feature is not active.

The zero-based index of this tour point in the stations array of the Route element.

The total period of the tour.

The total driving period.

The total waiting period.

The total time the driver arrived at a tour point before the opening times.

The total service period.

The total idle period.

The latest point of time at which the tour must be started in order to arrive on time at the last tour point. Will be nil if no opening intervals are given.

The remaining shift period. Only set if RoutingOption REMAINING_DRIVING_TIMES is present.

The remaining working hours during current shift. Only set if RoutingOption REMAINING_DRIVING_TIMES is present.

The remaining driving time before the next break. Only set if RoutingOption REMAINING_DRIVING_TIMES is present.

The remaining break period. Only set if RoutingOption REMAINING_DRIVING_TIMES is present.

The energy use tank-to-wheel in [MJ].

The CO2e tank-to-wheel in [kg].

The CO2e well-to-wheel calculation in [kg].

The CO2 tank-to-wheel in [kg].

The CH4 (methane) tank-to-wheel in [g].

The N2O (Nitrous oxide) tank-to-wheel in [g].

The tile ID where this UniqueGeoID is located.

The x-offset adress of this UniqueGeoID.

The y-offset adress of this UniqueGeoID.

The n-level of this UniqueGeoID.

The integration unit code where this node is located.

For example: 49 - germany; 33 - france; 34 - spain

The array index of the urban description text.

An optional array index of an additional urban description text. This index is only set if a manoeuvre has set the ManoeuvreAttribute.isUrbanStart and ManoeuvreAttribute.isUrbanEnd at the same time. In this case urbanIdx holds the index to the text of the urban area just left while additionalUrbanIndex holds the index to the urban area just entering

The value of the VehicleParameter

The type of the via point.

The accumulated time in [s] up to this station (arrival time), the first station has accTime = 0, the last station has accTime = routeInfo.time - link time. When using the calculateTour service, the arrival time does not comprise service, break, and rest at this station. This also applies to the last station; if there is a service period given, accTime + service period = routeInfo.time. Please use the corresponding TourPoint element for more information on arrival, service, and departure times.

The accumulated distance in [m] up to this station. The first station has accDist = 0. The last station has accDist = routeInfo.distance - link distance.

The integration unit code of the country in which this station is located.

The index in the polygon pointing to the polypoint right behind the station. For example if the polyIdx = 5, the station is located between polyIdx = 4 and polyIdx = 5

The index in the nodes array pointing to the node right behind the station. For example if the nodeIdx = 5 the station is located between nodeIdx = 4 and nodeIdx = 5.

The zero-based index in the segments-array pointing to the segment to which the station was linked. The coordinate of the segment is its beginning, but time and distance values are its end. Therefore accTime and accDist of this station are less or equal the respective values of the segment, and the location lies after the beginning of the segment. As there is no segment beginning at the last station, this index is invalid for the last station. Breaks, rests, and service periods calculated by calculateTour are added to the segment where the station was linked.

The zero-based index in the manoeuvre-array pointing to the manoeuvre right after the station. As there is no manoeuvre after at the last station, this index is invalid for the last station.

The coordinates of the location.

The coordinates of the link point (the intersection point of the perpendicular with the segment).

The WayPointType of this waypoint.

The optional country code information. If the RoutingParameter COUNTRY_ENCODING is not set, this attribute does not exist.

The accumulated amount of emissions of various substances.

The accumulated CEN emissions for this waypoint.

The coordinates of the location which have to be linked to roadnetwork. In case of a multilink, this can also be an array of coordinates treated as entrypoints for one single waypoint.

The linktype for the location which has to be linked to the roadnetwork.

The unique key to identify the node to which explicitly has to be linked.

This attribute is optional and does not need to be set.

Explicit linking to a node is not allowed for the methods calculateMatrixInfo, calculateIsochrones, and calculateReachableObjects.

The unique keys to identify the pair for the segment to which explicitly has to be linked.

This attribute is optional and does not need to be set.

Explicit linking to a segment is not allowed for the methods calculateMatrixInfo, calculateIsochrones, and calculateReachableObjects.

The radius for fuzzy linking to a certain location in [m].

The resulting via point may now be one of the nodes which can be reached within the given road distance from the co-ordinate. Be careful when using small values close to motorways. In that case it is very likely that the motorway is within the radius but none of the exits.

This algorithm uses a heuristic method, thus the result might not be the optimal solution especially when using several fuzzy waypoints one after the other..

This value is only interpreted for via-points with linkType FUZZY_LINKING in 1:1 routing requests and not when calculating a matrix.

Legal values are >=0, the default is 0.

The angle which specifies an additional constraint when linking a certain location to the road network. This means that the location will be linked to the geographically nearest segment which has approximately the same orientation as described in the heading. The tolerance can be given in the profile.

Legal angle values are 0 to 360 related to north in [deg] (clockwise).

This parameter is optional and has only an effect when using LinkType NEXT_SEGMENT, AUTO_LINKING or TI_LINKING and headingTolerance being configured in the profile.

A street name respectively street number which specifies an additional constraint when linking a certain location to the road network.
Street name of start/ destination can be different. This parameter is optional and has only an effect when using LinkType NEXT_SEGMENT, AUTO_LINKING or TI_LINKING.
Given street must match a segment, otherwise linking fails. Also several street names can be given in a list for a certain location. In this case all segments which match at least one of the street names, meet the plausibility constraint.

The syntax for this description is:

<streetname>[/<streetname>]*

The specific attributes for routing, up to the next waypoint. These options can only be used in the methods calculateRouteInfo(), calculateRoute(), calculateExtendedRoute() and calculateTour() of XRoute, otherwise the exception UNSUPPORTED_WAYPOINT_CONFIGURATION is thrown. There are routing parameters which must not be used here. See RoutingParameter, otherwise the exception INVALID_WAYPOINT_CONFIGURATION is thrown. Options are not allowed at fuzzy waypoints or combined transports, otherwise the exception UNSUPPORTED_WAYPOINT_CONFIGURATION is thrown.

The vehicle specific attributes, up to the next waypoint. These options can only be used in the methods calculateRouteInfo(), calculateRoute(), calculateExtendedRoute() and calculateTour() of XRoute, otherwise the exception UNSUPPORTED_WAYPOINT_CONFIGURATION is thrown. Options are not allowed at fuzzy waypoints or combined transports, otherwise the exception UNSUPPORTED_WAYPOINT_CONFIGURATION is thrown.

The type of the via point. Must be NULL for start and destination, otherwise the exception CONFLICT_VIA_TYPE is thrown. This type can only be used in the methods calculateRouteInfo(), calculateRoute(), calculateExtendedRoute() and calculateTour() of XRoute, otherwise the exception UNSUPPORTED_WAYPOINT_CONFIGURATION is thrown. Fuzzy waypoints and combined transports must not be used with TourPointDesc, otherwise the exception CONFLICT_TOUR_FUZZYPOINTS is thrown. The default value is VIA.

The unique key to identify a ferry or a piggyback transport. If the viaType COMBINED_TRANSPORT is selected, this attribute must be set. If combinedTransportID is set, the attribute coords must be null. Otherwise an exception is thrown.

Maximum period between the end of a weekly rest period and the beginning of the following weekly rest period.

Cumulative period of time a driver is allowed to drive within a week.

Cumulative period of time a driver is allowed to drive within two weeks.

Minimum period of time of a weekly rest.

Minimum duration of a required weekly rest.

Remark: According to NTC_AUS regulation: 24h (86400 s)

Maximum working period which cannot be exceeded in one week (7d or 168h).

Remark: According to NTC_AUS regulation: 72h (259200 s)

Minimum duration of required working break.

Minimum duration of extended break if workingPeriod exceeded.

Maximum duration of uninterrupted working time without having a break.

Maximum duration of uninterrupted working time without having an extended break.

Minimum duration break part if break is split.

Maximum working period after which a daily working rest must be done.

Maximum working period in a week.

Minimum uninterrupted daily rest period after work.

No tunnel or bridge.

Bridge over water.

Tunnel under water.

Bridge over railways.

Tunnel under railways.

Bridge over a street.

Tunnel under a street.

Bridge without any further description.

Tunnel without any further description.

The CEN calculation based on values from 2011 (EN16258:2011).

The CEN calculation based on values from 2012 (EN16258:2012).

The French CO2 decree no. 2011-1336, Article L.1431-3:2011. Only the following biofuel blends are supported: E10, E85 and B30. These blends can be set using the VehicleParameters FUEL_TYPE and BIO_FUEL_RATIO. For example E10 is represented by FUEL_TYPE=EUROSUPER and BIO_FUEL_RATIO=10. B30 is set by FUEL_TYPE=DIESEL and BIO_FUEL_RATIO=30.

The French CO2e decree no. 2017-639. Only the following biofuel blends are supported: E10, E85 and B30. These blends can be set using the VehicleParameters FUEL_TYPE and BIO_FUEL_RATIO. For example E10 is represented by FUEL_TYPE=EUROSUPER and BIO_FUEL_RATIO=10. B30 is set by FUEL_TYPE=DIESEL and BIO_FUEL_RATIO=30.

The emission calculation based on the Australian National Greenhouse Accounts (NGA), factors July 2011. To specify the emission class and the year of manufacture for each vehicle.

The emission calculation based on the emission factors provided by the Department for Environment, Food & Rural Affairs (Defra) in the United Kingdom, factors 2014.

The emission calculation based on the Australian National Greenhouse Accounts (NGA), factors December 2015. To specify the emission class and the year of manufacture for each vehicle.

none - not defined.

Euro

British pound (sterling) - United Kingdom

Danish krone - Denmark, Greenland

Norwegian krone - Norway

Krona - Sweden

Swiss franc - Switzerland, Liechtenstein

Polish z?oty - Poland

Tolar - Slovenia

Slovak koruna - Slovakia

Icelandic krona - Iceland

Turkish new lira - Turkey

United States dollar

Canadian dollar - Canada

Yen - Japan

Romanian leu - Romania

Lev (Лев) - Bulgaria

Forint - Hungary

Kuna - Croatia

Denar - North Macedonia

Lek - Albania

Bosnian and Herzegovinian konvertibilna marka - Bosnia and Herzegovina

Kroon - Estonia

Serbian dinar - Serbia

Lat - Latvia

Litas - Lithuania

Maltese lira - Malta

Moldovan leu - Moldova

Cyprus pound - Cyprus

Rand - South Africa

Czech Koruna - Czech Republic

Only Borders

The entering, leaving and changing of highways; The entering of ferries.

All manoeuvres.

All road changes.

The nodes with more than one trailing segment.

An additional manoeuvre. This level cannot be requested. All manoeuvres which are additional manoeuvres have detail ORTHOGONAL(like brunnel manoeuvres).

All the rest.

No emission calculation.

Only the total amount of emissions.

The total amount of emissions and the emissions per segment.

The total amount of emissions and the emissions per station.

The total amount of emissions and the emissions per segment and per station.

Calculation successful.

The user aborted the request.

Deprecated. This error will not be used anymore.

Deprecated. This error will not be used anymore.

This error will not be used anymore.

Deprecated. This error will not be used anymore.

Deprecated. This error will not be used anymore.

Deprecated. This error will not be used anymore.

An attribute contains an invalid enumeration value. Please check the request.

At least one station has link type NEXT_MAIN_TOLL_NODE which is not supported anymore

Expansion description invalid, the horizons are not in increasing order.

The network class filter-array exceeds dimension.

Deprecated. This error will not be used anymore.

Conflicting options in request.

General license error. Licence is not valid or expired. Check license contents.

The binary path description is corrupt.

The polyline representation of an exception path can currently only be used in combination with a relative malus of -99.

Maximum length of the exception path's polyline exceeded.

The service method calculateMatrixInfo() does not support an exception path containing a street name.

The service methods calculateMatrixInfo(), calculateIsochrones(), calculateReachableObject(), and searchForReachableObjects() do not support RoutingParameter DYNAMIC_TIME_ON_STATICROUTE.

Inaccurate path descriptions in ExceptionPath, neither representation could be considered.

The intersecting line has to be a linestring containing exactly two points.

Error in WaypointDesc object: no coordinates set.

Error in WaypointDesc object: explicit linking (segmentID or nodeID set) as well as coordinates set.

Error in WaypointDesc object: segmentID as well as nodeID set.

Error in WaypointDesc object: segmentID does not consist of a pair of UniqueGeoIDs

Error in WaypointDesc object: segment could not be found or composed by the two specified UniqueGeoIDs.

A combined transport waypoint has an invalid configuration.

Explicit linking to node or segment ID is not supported by this method.

Conflict with waypoint count.

Start or destination waypoint has a fuzzyRadius, or ViaType and LinkType contradict.

Start and destination waypoint must not specify a via type.

Flight distance between start and destination too big.

Parsing external segments (string) failed.

Empty resultlistoptions. This options are mandatory.

ResultListOption dynamicInfo can only be used if ENABLE_DYNAMIC is true or a FeatureLayer theme is configured with enabled time-dependency.

RoutingParameter DYNAMIC_TIME_ON_STATICROUTE can only be used if ENABLE_DYNAMIC is true or a FeatureLayer theme is configured with enabled time-dependency.

RoutingParameter ENABLE_DYNAMIC_WITH_FREE_FLOW_SPEED can only be used if ENABLE_DYNAMIC is true or a FeatureLayer theme is configured with enabled time-dependency

Both RoutingParameter ROUTING_COUNTRIES and EXCLUDE_COUNTRIES set.

RoutingParameter out of range.

Wrong RoutingParameter.

Empty RoutingOption.value string.

VehicleParameter out of range.

Empty VehicleOption.value string

Conflicting vehicle options (probably the weights are not plausible such as empty weight + load weight > total weight).

Calculate(Advanced)Tour does not support fuzzy waypoints which are declared as tour points.

Calculate(Advanced)Tour does not support road editor layers which are stored in a database.

Calculate(Advanced)Tour does not support time dependency in feature layer configuration.

Calculate(Advanced)Tour does not support dynamic routing.

Calculate(Advanced)Tour does not support the destination time attribute.

Conflict tour calculation - both start and destination waypoints need to be tour points.

The break and rest rules (or regulation parameters) are invalid. Make sure that all values are > 0 and the maximum values are > their corresponding values (such as total break period > first break period).

The intervals of a tour point (or the break or operating intervals) are invalid. Please make sure that at least one of the intervals ends after the start of the route. Furthermore, the intervals must be disjoint and ascending. The object in question is stated in the response.

The siteID is invalid, it must be > 0.

The useCase is invalid, this value should not be set without collaboration with PTV's support.

A parameter is invalid or conflicts with another parameter. Details are stated in the response.

An error occurred during the calculation of the advanced tour. Details are stated in the response.

No sink and no pathdesc or both of them are given for reachable object request. Exactly one of them must be set.

No locations set for reachable object request.

Error in reachable object request: no expansion description set.

Invalid or no sink in isochrones or reachable object request.

Error in isochrone object request: no iso options set.

Error in isochrone object request: no expansion description set.

Error in isochrone object request: no horizons set.

Unknown currency.

Converting currency to euro failed.

redcutionIDs are not supported.

Setting deprecated ci parameter TRAILER_HAS_BREAKS not allowed.

Cannot calculate 1 to n route.

Error calculating reachable objects.

Error calculating isochrones.

Cannot calculate route.

Problem calculating routelist.

Error in calculating manoeuvres.

Error in calculating toll.

Could not set scenario for country.

Could not set scenario by toll date.

Supplementary map data is missing. Some response data can not be provided because of the lack of additional data files (which are not included in the installed map).

Linking to waypoint failed.

Setting pattern over time profile failed.

Accessing pattern over time layer failed.

ID mapping failed.

ID mapping data is not present, neither can extSegments be requested, nor can an ExceptionPath contain extSegments

Wrong roadeditor parameter.

ROADEDITOR_ADDITIONAL_PARAMETERS contains DIR_OPT_COND_MALUSn without a second parameter, but neither MAX_WEIGHT nor MAX_WEIGHT_DIR are specified.

Accessing roadeditor layer failed, probably the specified layer name does not exist, or no layer name has been specified.

Setting deprecated routing parameter ROADEDITOR_ATTRIBUTESET not allowed.

The feature is used in the request but not configured in xroute.properties.

Deprecated

Deprecated

Deprecated

Wrong distance measure requested.

Waypointlist should contain at least two waypoints.

Unable to execute emission calculation, emission data is not properly configured, see configuration file for details.

Unable to execute emission calculation, emission data is not available for this vehicle, see documentation for details.

Unable to execute emission calculation with this service method, see documentation for details on the service methods which allow emission calculation.

The vehicle profile for emission calculation is invalid or incomplete.

Speed limits cannot be requested, no valid license available.

RoutingOption GEODATASOURCE_LAYER is not formatted correctly.

Unable to evaluate RoutingOption GEODATASOURCE_LAYER due to a problem accessing the geodatasource. Further error information will be specified in the response, check the request and the geodatasource configuration and profiles.

ReachableObjectsOption 'geodatasourceLayer' is not formatted correctly.

Unable to evaluate ReachableObjectsOption 'geodatasourceLayer' due to a problem accessing the geodatasource, further error information will be specified in the response, check the request and the geodatasource configuration and profiles.

For calculating reachable objects, the horizons array in the ExpansionDescription element must be of length 1.

This service-method does not support exceptionPath elements.

This service-method does not support vehicle or routing options.

The option is not supported for waypoints.

The language requested is not supported. Probably it is not configured correctly or missing at all.

Isochrones calculation does not support road editor.

Reachable objects calculation does not support road editor.

Reachable objects calculation does not support dynamic.

Retrieving emission and energy conversion factors failed.

RoutingOption AVOID_NATIONALNAMEDTOLL_ROADS is not formatted correctly.

The FeatureLayer configuration is invalid.

The required FeatureLayer PTV_TimeZones is missing in the map data.

Data for one or several requested FeatureLayer themes is not available.

Invalid configuration of high-performance routing. High-performance routing  network is configured in xroute.properties.

The profile data compatibility version doesn't match the map version

Deprecated. This error will not be used anymore.

The profile could not be processed, probably it does not exist, it is not well-formed XML, it could not be validated against the schema, or the version is not supported.

Time expansion (time must be given in [s]).

Distance expansion (distance must be given in [m]).

HBEFA 2.1. This is the default.

HBEFA 3.1.

HBEFA should not be used. Currently this value makes only sense if emission should be calculated with CEN 2012 without HBEFA restrictions.

HBEFA 3.2

COPERT 1.2 for Australia

No special type is used.

End of motorway.

A motorway junction.

A three-way motorway interchange.

A motorway interchange.

A Border.

Built-Up area.

A Ferry terminal.

A toll road.

A sign.

The isochrone is described only by the surrounding polygon.

The isochrone is described only by all segments corresponding to the isochrone.

The isochrone is described by both polygons and segments.

The waypoint has to be linked to the geographically nearest valid node within the configured link distance. A node is valid if it can be used by the configured vehicle type.

The waypoint has to be linked to the geographically nearest valid segment within the configured link distance. A segment is valid if it can be used by the configured vehicle type.

The waypoint has to be linked to the geographically nearest valid main node (for example a motorway interchange) within the configured link distance. A main node is a collection of entry-nodes representing the interchange. The main node is valid if it can be used by the configured vehicle type. A main node is a collection of entry nodes representing the interchange.

The waypoint has to be linked by fuzzy linking according to a given radius. FUZZY_LINKING is only valid for VIA-Points. Deprecated, use ViaTypeEnum::FUZZY instead.

The waypoint is linked by auto linking according to the following three steps. 1. Use link-type NEXT_SEGMENT. 2. Search for nearby main nodes as with link-type NEXT_MAIN_NODE. The radius of this search depends on the segment found in the first step and whether the waypoint is an intermediate via waypoint or not. If a main node is found link to all entry nodes of the main node, otherwise link to the segment found in the first step. 3. If a main node has been found check if one entry node of the main node belongs to a toll station. In this case link to all nodes that belong to the toll station with the minimal distance to the main node.

This LinkType is not supported anymore, use a different one.

The waypoint has to be linked to the geographically nearest valid toll station within the configured link distance. A toll station is valid if it can be used by the configured vehicle type.

Linking is executed in two steps: 1. Use link-type NEXT_MAIN_NODE. If some segments adjacent to an entry-nodes of the resulting main-node has the wanted name, take all these entry-nodes. 2. Otherwise, consider all segments within a given radius.

A manoeuvre group including one or several manoeuvres close to each other being part of a complex intersection shape.

Describes a manoeuvre group including one or several manoeuvres close to each other.

further

keep

turn

U-Turn

Enter

Exit

Enter roundabout

Stay in roundabout

Exit roundabout

Change highway

Enter the ferry resp. piggy-back
This parameter also represents the enter manoeuvre regarding piggy-back.

Leave the ferry respectively piggy-back
This parameter also represents the exit manoeuvre regarding piggy-back.

Exit roundabout and enter immediately.

Exit roundabout and enter the ferry immediately.

Motorways

Highways

Trunk roads

Country roads

City roads

Residential roads

Drivable but normally blocked roads (for cars).

Cycle lanes and walkways

Dynamic routing with POT (pattern over time) including a FreeFlowSpeed-Phase: the maximum speed at this day without any obstacles.

Dynamic routing with POT (pattern over time) not including FreeFlowSpeed-Phase: the maximum speed at this day within the POT.

Routing without dynamic. Therefore the speed is given according to the network/speed class.

A node-based isochrone calculation, where the surrounding polygon connects the endpoints of all isochrone segments.

A tile-based isochrone calculation where the surrounding polygon connects the centers of all reachable tiles of the isochrone.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

See use case documentation.

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation

see use case documentation