service

Types

DeprecatedParameterLimitation

extends ResultLimitation
since 2.14

This result limitation indicates that a deprecated parameter is used..

Field Name Type Required Default Since Description
parameter String yes - 2.14 Identifies the deprecated parameter as an XPath path expression.

ExchangeRatesNotProvidedLimitation

extends ResultLimitation
since 2.26

This result limitation indicates that the provided exchange rates do not cover all exchange rates that were required and that in these cases exchange rates that are provided with the map data are used.

Field Name Type Required Default Since Description
usedExchangeRates ExchangeRate[] 1..* - 2.26 The exchange rates that were used relative to the base currency of the request.

FeatureLayerMatchLimitation

extends ResultLimitation
since 2.0

This result limitation indicates that one or more Feature Layers corresponding to a Feature Layer theme do not fit the currently used map. Such a situation could reduce the quality of the result. The user is requested to update the Feature Layer data for this theme or the map so that both have the same version. If in doubt, contact your PTV representative for help.

Field Name Type Required Default Since Description
themeId ThemeId (String) yes - 2.0 ID of the Feature Layer theme which does not fit the map.
countries CountryCode[] (String[]) 0..* - 2.0 Codes of countries whose Feature Layers of the theme referred to by the parameter above are not fitting the map.

FeatureLayerNotAvailableLimitation

extends ResultLimitation
since 2.23

This result limitation indicates that a certain Feature Layer is not available although content updates are enabled for it. This may happen right after starting PTV xServer or restarting a module when a request is processed before the content updates have finished, or when there is no data available for this Feature Layer.

Field Name Type Required Default Since Description
themeId ThemeId (String) yes - 2.23 ID of the Feature Layer theme which does not exist.

FeatureNotAvailableLimitation

extends ResultLimitation
since 2.0

This result limitation indicates that a certain feature is not available. For example it could occur in a situation where the API contains a list of entities but the business logic can only treat a single entity. In general it occurs when the API foresees a situation which is not recognized in the business logic yet but still allows a result to be created.

Field Name Type Required Default Since Description
feature String yes - 2.0 Name of the requested feature

FeatureNotLicensedLimitation

extends ResultLimitation
since 2.3

This result limitation indicates that some optional data content has not been used because it is not licensed. For example, if the routing type is RoutingType.HIGH_PERFORMANCE_ROUTING_WITH_FALLBACK_CONVENTIONAL and high-performance routing is not licensed, a conventional routing is done and a result limitation is generated. Normally, if the data content is not optional, a SetupFault is returned.

Field Name Type Required Default Since Description
key String yes - 2.3 The name of the license key

GeometryOptions

used by RequestBase
since 2.0

Options for returned geometries.

Field Name Type Required Default Since Description
responseGeometryTypes EncodedGeometryType[] 0..* - 2.0 the target encodings of geometries

IgnoredParameterLimitation

extends ResultLimitation
since 2.27

This result limitation indicates that a parameter was ignored.

Field Name Type Required Default Since Description
ignoredParameter String yes - 2.27 Identifies the parameter which was ignored as an XPath path expression.
ignoredValue String no - 2.27 The value of the ignored parameter.
relatedParameter String yes - 2.27 Identifies the parameter that was considered related to the ignored parameter as an XPath path expression.
relatedValue String no - 2.27 The value of the related parameter.

IntermediateResponseLimitation

extends ResultLimitation
since 2.9

This result limitation indicates that the request has been stopped either by the user or due to a timeout. The returned response is an intermediate but valid response that usually differs from the final response.

Field Name Type Required Default Since Description
reason IntermediateResponseReason no - 2.12 The reason for this limitation.

ObjectNotStoredLimitation

extends ResultLimitation
since 2.9

This result limitation indicates that an object could not be stored in the session storage.

No fields defined.

ParameterIgnoredLimitation

extends ResultLimitation
since 2.0

This result limitation indicates that a parameter was ignored.

Field Name Type Required Default Since Description
ignoredParameter String yes - 2.0 Identifies the parameter which was ignored as an XPath path expression.
requiredParameter String yes - 2.0 Identifies a parameter which is required to be specified in order to process the ignored parameter as an XPath path expression.

ParameterInconsistencyLimitation

extends ResultLimitation
since 2.0

This result limitation indicates that a parameter is not consistent with other parameters. For example, the actual weight of a vehicle is larger than the total permitted weight.

Field Name Type Required Default Since Description
parameter String yes - 2.0 Identifies the parameter as an XPath path expression. For example, vehicleProfile/weight/@totalPermittedWeight.
value String yes - 2.0 The value of the parameter.
relatedParameter String no - 2.27 Identifies the related parameter as an XPath path expression. For example, vehicleProfile/weight/@totalPermittedWeight
relatedValue String no - 2.27 The value of the related parameter.

Base type for any xServer request type. Contains a RequestProfile.

Field Name Type Required Default Since Description
scope ScopeName (String) no globalscope 2.0 A user defined scope for persistent data like distance matrices.
storedProfile Url (String) no default 2.0 The URL of the stored profile used by this request. The following types of URLs are supported:
  • The name of the profile without its extension, e.g. bicycle. The corresponding file bicycle.xml must be available in the folder conf/profiles. Parent profiles must be located in the same folder. Profile names must not contain the special characters '-' and '+' and must not be called 'transport', 'labels', or 'background'.
  • An http url, e.g. http://localhost:8080/profiles/bicycle.xml from which the profile must be available. In order to limit the access to outside servers, a whitelist can be configured in xserver.conf (see here). Parent profiles are not allowed for http urls.
The URL is case-sensitive, although Microsoft Windows also accepts case-insensitive file names.
requestProfile RequestProfile no - 2.0 The profile used by this request (parameters override those from storedProfile).
coordinateFormat CoordinateFormat (String) no EPSG:4326 2.0 The coordinate format of all geometries in request and response. The default of EPSG:4326 represents WGS84. For more information see here.
geometryOptions GeometryOptions no - 2.0 The target encodings of geometries, PLAIN if empty.
timeouts Timeouts no - 2.0 timeout settings
userLogs String[] 0..* - 2.0 values to be written to the log file (note that they must not contain a semicolon)

Base type for any xServer response type. Contains a list of result limitations, which indicates an alleviated quality of the result.

Field Name Type Required Default Since Description
resultLimitations ResultLimitation[] 0..* - 2.0 A list of limitations that apply to this result. If there are entries in this list, this means that while the server was able to provide a best effort to reply to the request, the limitations to the validity of this result described in this list have to be considered.

Timeouts

used by RequestBase
since 2.0

Overrides the timeouts configured in xserver.conf for the current request.

Field Name Type Required Default Since Description
queueingTimeout Milliseconds (Integer) no - 2.0 Maximum time that this request may remain in the request queue if no module process is available to handle the request. This value overrides the value of core.requestQueueTimeout for synchronous and core.jobs.jobQueueTimeout for asynchronous requests, respectively.
computationTimeout Milliseconds (Integer) no - 2.0 Maximum time that this request may take to execute on a module process. This value overrides the value of core.moduleTimeout for synchronous and core.jobs.jobModuleTimeout for asynchronous requests, respectively. If the timeout is exceeded, the request is tried to be stopped. An intermediate result is returned together with an IntermediateResponseLimitation if it is already available. Otherwise a XServerException containing a RequestTimedOutFault is thrown.

UTCOffsetAmbigiousLimitation

extends ResultLimitation
since 2.14

This result limitation indicates that the time zone for a given time could not be determined unambiguously. In this case the time zone was determined as described in the technical concept, and the chosen time zone is given.

Field Name Type Required Default Since Description
utcOffset UTCOffset (int) yes - 2.14 The UTC offset finally used.

UTCOffsetNotDeterminableLimitation

extends ResultLimitation
since 2.14

This result limitation indicates that the time zone for the given reference time could not be determined. This usually happens when requesting a map in an area where no roads with attached time-zone information are present, e.g. in uninhabited areas or in the sea. Therefore, this result limitation can usually be ignored as there will be no time-dependent information available in this area. PTV xServer assumes UTC as the time zone for this request.

No fields defined.

VoidResponse

extends ResponseBase
used by XData, XDima, XRuntime
since 2.0

Empty response type for calls that do not return any meaningful data.

No fields defined.
Enumeration

IntermediateResponseReason

used by IntermediateResponseLimitation
since 2.12

The reason for an intermediate response limitation.

Enumeration Value Since Description
REQUEST_STOPPED 2.12 The request was stopped by calling the stopRequest method from XRuntime for synchronous or a service specific stopJob method for asynchronous requests, respectively.
REQUEST_TIMED_OUT 2.12 The request was stopped due to a timeout. For further information see Timeouts.computationTimeout.

Diagrams

Service

Result Limitations