The name of the result field.

The value of this field. Depending to the fieldtype, numeric values are possible within the string.

The country code of this address. Depends on the COUNTRY_CODETYPE settings.

The state code of this address.

The postcode of this address.

The city name of this address.

The city district of this address.

The street name of this address.

The house number of this address.

An engine error occured while searching, see ErrorCode for possible Values.

A textual description of the error code, see ErrorCode for possible values.

The list of found address candidates.

The coordinate of the combined transport location.

The country of the combined transport.

The name of the combined transport location.

An Engine Error occured while searching, see ErrorCode for possible Values.

A textual description of the error code, see ErrorCode for possible values.

A list of found combined transport candidates.

The name of the field.

Blob content of the field.

The float value of the field.

The integer value of the field.

The String value of the field.

The coordinate of the location.

The parameter of the searchoption.

An engine error occured while searching, see ErrorCode for possible Values.

A textual description of the error code, see ErrorCode for possible values.

A list of found objects results. The list may contain addresses and combined transports

The address category of the POI. A numeric value that specifies the POI category. Several types can be stated separated by a blank or semicolon. For detailed information see: PTV POI types.

The address name of the POI.

The SQL filter will be attached at the end of the WHERE clause. Valid expressions are comparisons (<, >, =, like, ...). Concatinations of expressions are possible with the SQL operators AND and OR.

If the geodatasource layer configuration is set, the xlocate returns all of the configured attributes as additional databaseFields except for the basic address attributes. There is no need to configure the additionalFields element of the request.

An Engine Error occured while searching, see ErrorCode for possible Values.

A textual description of the error code, see ErrorCode for possible values.

List of found POI address candidates.

The address category of the POI. A numeric value that specifies the POI category. Several types can be stated separated by a blank or semicolon. For detailed information see: PTV POI types.

The name of the POI address.

The range to search in meter.

A polygon to specify where to search POIs, for example search all castles in the black forest. This feature is not yet implemented, its value will be ignored.

If the geodatasource layer configuration is set, the xlocate returns additional databaseFields.

The address category of the POI. A numeric value that specifies the POI category. For detailed information see: PTV POI types.

The name of the POI.

A list of database fields configured in the geodatasource layer configuration. Only set if geodatasource is not empty.

The parameter of the POISearchOption.

The administrative address supplement of the address.

The appendix of the address.

The capital of the country.

The detail level of the candidate. See DetailLevelDescription for possible values.

The classification of the address candidate based on the quality of the match. See ClassificationDescription for possible values.

The coordinates of the address candidate.

Additional result fields. The fields are returned in the same order as they have been requested.

The unique key to identify the combined transport.

The name of the combined transport.

The duration in seconds of the combined transport.

The distance to the input location in meters.

The type of the combined transport. Legal values are:

1 - ferry: The combined transport is a ferry boat connection.

2 - piggyback: The combined transport is a piggyback train connection.

The start of the combined transport.

The destination of the combined transport.

Additional combined transport result fields. The fields are returned in the same order as they have been requested.

An address object.

The parameter of the SearchOption. See ReverseSearchParameter for possible values.

The parameter of the search option. See SearchParameter for possible values.

The value of the parameter.

Specifies the sort field, see ResultField enumeration. Every result field can be used as a sorting field.

Sort order, see SortOrder enumeration.

The suggested text of the address.

Not implemented yet.

The resultlist of the suggestion. At the moment at most 5 candidates are listed.

An engine error occured while searching, see ErrorCode for possible values.

A textual description of the error code, see ErrorCode for possible values.

No classification is available.

The address candidate has a low quality.

The address candidate has an average quality.

The address candidate has a close match to the input.

The address candidate can be considered as exact.

The address candidate can be considered as unique. In addition to EXACT, UNIQUE indicates possible candidates when batch geocoding addresses.

The candidate was found on country level.

The candidate was found on state level.

The candidate was found on global postcode level.

The candidate was found on city level.

The candidate was found on city district level.

The candidate was found on postcode level.

The candidate was found on street level.

The candidate was found on house number section level. The address candidate does not contain an exact house number.

The candidate was found on house number link level.

The candidate was found on house number level, the house number was interpolated.

The candidate was found on house number level, the data contained the exact house number.

The candidate was found on intersection level, the result data is an intersection.

Description: An error occurred in a call to the native locating engine kernel. The error record contains the native description and the native error code (in parenthesis). These codes are:

Engine Errorcodes

Possible cause:

• The used map data version does not match to the xLocate version.
• You have found a bug in one of the xLocate search engines.

Solution:

• Contact your xLocate support.

Description: Data path has not been specified in the module configuration.

Possible cause:

• The used maps.path key in xlocate.properties has no value.

Solution:

• Add the key and set a valid path.

Description: The engine could not be properly initialized.

Possible cause:

• The used xLocate mode is deactivated at your xLocate configuration.

Solution:

• Check supported.engine key in the xlocate.properties file.

Description: The native classification of the engine does not match with the enumeration Classification. The detail level description of the engine does not match with the enumeration DetailLevelDescription.

Possible cause:

• The used Search Engine does not match to the xLocate module.

Solution:

• Use the provided Search Engines.

Description: Every search option passed to the service NamedSearchOption is dynamically compared with the available options in the locating kernel of the engine.

Possible cause:

• The used search option has been specified as unknown.

Solution:

• For valid values check the SearchParameter, ReverseSearchParameter and PoiSearchParameter Documentation.

Description: Every requested additional field is dynamically compared with the available fields in the locating kernel of the engine.

Possible cause:

• The used additional field has been specified as unknown.

Solution:

• For possible values check the ResultField documentation.

Description/Possible cause: A problem handling any relatively referenced configuration entity in the configuration files of the module.

Solution: Check your configuration files. The Paths have to match with the xLocate root folder.

Description: Map license is invalid or no map has been licensed at all.

Possible cause:

• There is no license.ptv file in the xLocate root folder.
• The license has expired.
• The host list is invalid.

Solution:

• Copy a valid license.ptv file to the xLocate root folder.
• Use the PTV xServer Management Console to check the expiry date and host list.

Description: Parameterization is invalid. Not used yet/anymore.

Possible cause:

• None.

Solution:

• None.

Description: The result list exceeded the maximum length.

Possible cause:

• The xLocate search engine found more results than configured in your configuration.

Solution:

• Precise your search request.
• Increase the maximum result count in your configuration files.

Description: There is no address input data.

Possible cause:

• The requested address object is null or empty.

Solution:

• Add the request address data to the request.

Description: There is no location input data.

Possible cause:

• The requested location or coordinate object is null or empty.

Solution:

• Add a coordinate to the request.

Description: The location coordinates are invalid.

Description: There user has stopped the request.

No classification is available.

The result field is empty.

The input field is empty.

Not contained in any other classification.

Not contained in superior classifications and when Match quality medium is set.

Not contained in superior classifications and when Match quality high is set.

See the description in the characteristics table.

The fields Postalcode and Housenr have to match exact. The fields City/City2 and street have to match exact and the input is the prefix of the result.

Specifies the result language. If a candiate has specific aliases, they will be returned in this language. Legal values are the ISO3 language codes. This feature is not yet supported by the xLocate POI Engine.

The maximum number of returned candidates.

The type of country code used for POI geocoding. Legal values are non negative integer values:

• 0 - country code (number)
• 1 - ISO2
• 2 - ISO3
• 3 - country code plate

The country code of the result.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The state code of the result.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The administrative region and administrative address supplement respectively.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The city of the result.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The city district of the result.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The postcode of the result.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The street of the result.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The house number of the result. May be returned as an interpolated house number.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The x-coordinate of the found candidate converted to PTV_GEODECIMAL.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The y-coordinate of the found candidate converted to PTV_GEODECIMAL.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

Information about the data level on which the match was made. DETAILLEVEL is a non negative integer, see DetailLevelDescription for possible values.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

Same as DETAILLEVEL, in a readable form.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

City population as specified by the data provider.

Number of inhabitants for the POPULATION value:

• 0: unknown
• 1: < 100
• 2: 100 - < 200
• 3: 200 - < 500
• 4: 500 - < 1,000
• 5: 1,000 - < 2,000
• 6: 2,000 - < 3,000
• 7: 3,000 - < 5,000
• 8: 5,000 - < 10,000
• 9: 10,000 - < 20,000
• 10: 20,000 - < 50,000
• 11: 50,000 - < 100,000
• 12: 100,000 - < 250,000
• 13: 250,000 - < 500,000
• 14: >= 500,000

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()
• matchLocation()
• matchLocations()
• findLocation()
• findLocations()

Extension class as specified by the data provider.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

City level as specified by the data provider.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

For internal use only. This flag indicates if a name exists for the city district (= true) or if the city district is made up only by its postcode (= false).

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

ISO2 code of the country.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

ISO3 code of the country.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

Code on the country code plate.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

Dialing code of the country.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

Capital of the country.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The name of the country.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

For internal use only. Indicates the side of the road where the house number is located.

Supported by:

• matchAddress() (for internal use only)
• matchAddresses() (for internal use only)
• findAddress() (for internal use only)
• findAddresses() (for internal use only)
• findAddressByText() (for internal use only)
• findObjectByText() (for internal use only)

For internal use only. Specifies how the house number is structured (for example numeric / alphanumeric).

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

For internal use only. Specifies how the house number is structured (for example numeric / alphanumeric).

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

For internal use only. Specifies how the house number is structured (for example numeric / alphanumeric).

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The appendix of the address.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The Score indicating the overall quality of the address candidate.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The penalties that apply to the address candidate.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

For internal use only. Indicates how the city was found. Legal values are non negative integers:

• 0 - Undefined
• 1 - BinarySearch
• 2 - PhoneticSearch
• 4 - FuzzySearch
• 8 - FilledByAddToResultList
• 32 - RetrievedByGetData
• 64 - GetAll
• 128 - Retrieve

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

For internal use only. Indicates how the city district was found. Legal values are non negative integers:

• 0 - Undefined
• 1 - BinarySearch
• 2 - PhoneticSearch
• 4 - FuzzySearch
• 8 - FilledByAddToResultList
• 32 - RetrievedByGetData
• 64 - GetAll
• 128 - Retrieve

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

For internal use only. Indicates how the postcode was found. Legal values are non negative integers:

• 0 - Undefined
• 1 - BinarySearch
• 2 - PhoneticSearch
• 4 - FuzzySearch
• 8 - FilledByAddToResultList
• 32 - RetrievedByGetData
• 64 - GetAll
• 128 - Retrieve

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

For internal use only. Indicates how the street was found. Legal values are non negative integers:

• 0 - Undefined
• 1 - BinarySearch
• 2 - PhoneticSearch
• 4 - FuzzySearch
• 8 - FilledByAddToResultList
• 32 - RetrievedByGetData
• 64 - GetAll
• 128 - Retrieve

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

Classifies the address candidate based on the quality of the match. CLASSIFICATION is a non negative integer, see ClassificationDescription for possible values.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

Same as CLASSIFICATION, in a readable form.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

As of  xLocate version 1.17 the value is always 0.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

Additional POI Information, for example website of the POI.

Supported by:

• findPoiByAddress()
• findPoiByAddresses()
• findPoiByLocation()
• findPoiByLocations()

Phone number of the POI.

Supported by:

• findPoiByAddress()
• findPoiByAddresses()
• findPoiByLocation()
• findPoiByLocations()
• findAddressByText()
• findObjectByText()

Deprecated.

Deprecated.

Deprecated.

Deprecated.

Deprecated.

The segment ID of the data provider (e.g. HERE). This feature only works on street level, additional ID mapping data has to be installed.

Supported by:

• matchLocation()
• matchLocations()
• findLocation()
• findLocations()

The country where the segment belongs to. This feature only works on street level, additional ID mapping data has to be installed.

Supported by:

• matchLocation()
• matchLocations()
• findLocation()
• findLocations()

The digitalization direction of the segment in the map data. This information is needed for some xMap and xRoute usecases. This feature only works on street level, additional ID mapping data has to be installed.

Supported by:

• matchLocation()
• matchLocations()
• findLocation()
• findLocations()

A LINESTRINGXYN(country tile x y n) that represents the start and end node of the linked segment in the roadnetwork by its geographical xyn-position.

Supported by:

• matchLocation()
• matchLocations()
• findLocation()
• findLocations()

The name of a point of interest.

Supported by:

• findPoiByAddress()
• findPoiByAddresses()
• findPoiByLocation()
• findPoiByLocations()

A numeric value that specifies the POI category. For detailed information see: PTV POI types.

Supported by:

• findPoiByAddress()
• findPoiByAddresses()
• findPoiByLocation()
• findPoiByLocations()

Classifies the address candidate based on the quality of the match. This value is the extended version of the ResultField CLASSIFICATION.

ADDRESS_CLASSIFICATION includes the classification of the complete result address. Based on the characteristics and classification of each field of the address.

ADDRESS_CLASSIFICATION is a non negative integer, see ADDRESS_CLASSIFICATION_DESCRIPTION for possible values.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

Same as ADDRESS_CLASSIFICATION, in a readable form.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

Classifies the postcode field of the address candidate based on the quality of the match. POSTCODE_CLASSIFICATION is a non negative integer, see FieldClassificationDescription for possible values.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

Classifies the city and city2 field of the address candidate based on the quality of the match. TOWN_CLASSIFICATION is a non negative integer, see FieldClassificationDescription for possible values.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

Classifies the street field of the address candidate based on the quality of the match. STREET_CLASSIFICATION is a non negative integer, see FieldClassificationDescription for possible values.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

Classifies the housenumber field of the address candidate based on the quality of the match. HOUSENR_CLASSIFICATION is a non negative integer, see FieldClassificationDescription for possible values.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The postcode characteristics. See Characterization bitfields description for further information.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The town characteristics. See Characterization bitfields description for further information.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The street characteristics. See Characterization bitfields description for further information.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The housenr characteristics. See Characterization bitfields description for further information.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The words, which are not used for the search. For example the search "Wellenstein Rue de la Moselle xyz" has "xyz" as unmatched words because this word does not exist as a street in Wellenstein.

See also UNMATCHED_WORDS_COUNT.

Supported by:

• findAddressByText()
• findObjectByText()

The number of unmatched words for the search with the method findAddressByText(). See also UNMATCHED_WORDS.

Supported by:

• findAddressByText()
• findObjectByText()

The reference x-coordinate of the street converted to PTV_GEODECIMAL. -1 if the result DetailLevel is lower than STREET.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The reference y-coordinate of the street converted to PTV_GEODECIMAL. 1 -if the result DetailLevel is lower than STREET.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The reference x-coordinate of the admin region converted to PTV_GEODECIMAL.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The reference y-coordinate of the admin region converted to PTV_GEODECIMAL.

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

The tile local n-coordinate of the found combined transport end physical node.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

The tile local x-coordinate of the found combined transport end physical node.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

sThe tile local x-coordinate of the found combined transport end physical node

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

The tile y-coordinate in smart units of the found combined transport end physical node.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

The tile x-coordinate in smart units of the found combined transport end physical node.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

The country code of the start location as ptv number.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

The tile local n-coordinate of the found combined transport start physical node.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

The tile local y-coordinate of the found combined transport start physical node.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

The tile local x-coordinate of the found combined transport start physical node.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

The tile y-coordinate in smart units of the found combined transport end physical node.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

The tile x-coordinate in smart units of the found combined transport end physical node.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

The country code of the start location as ptv number.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

If true, the combined transport is blocked for pedestrians. Legal values are true and false.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

If true, the combined transport is blocked for bicycles. Legal values are true and false.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

If true, the combined transport is blocked for motor cycles. Legal values are true and false.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

If true, the combined transport is blocked for cars. Legal values are true and false.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

If true, the combined transport is blocked for vans. Legal values are true and false.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

If true, the combined transport is blocked for camper. Legal values are true and false.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

If true, the combined transport is blocked for buses. Legal values are true and false.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

If true, the combined transport is blocked for combustible good transports. Legal values are true and false.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

If true, the combined transport is blocked for combustible good transports. Legal values are true and false.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

If true, the combined transport is blocked for trucks. Legal values are true and false.

Supported by:

• findCombinedTransportByLocation()
• findObjectByText()

Indicates, that the result candidate has no city center point in the map data. Legal values are non negative integers:

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()

City display level as specified by the data provider.

Supported by:

• findLocation()
• findLocations()
• matchLocation()
• matchLocations()

Street number as specified by the data provider.

Supported by:

• findLocation()
• findLocations()
• matchLocation()
• matchLocations()

Indicates the side of the road where the house number is located.

• 0 means, it is the same side as the query coordinate was.
• 1 means, there are no houseNumbers at the same side, thus the returned one is from the opposite side.
• 2 means that no specification could be given. This could be, because the query coordinate is very near to the street, or because no house number is returned, at all.

Supported by:

• matchLocation()
• matchLocations()
• findLocation()
• findLocations()

Represents the second highest administrative level below the country. This data is not available for all maps and countries

Supported by:

• matchAddress()
• matchAddresses()
• findAddress()
• findAddresses()
• findAddressByText()
• findObjectByText()
• matchLocation()
• matchLocations()
• findLocation()
• findLocations()

Type of country code to return when reverse geocoding. Legal values are non negative integer values:

• 0 - Country name
• 1 - ISO2
• 2 - ISO3
• 3 - country code plate
• 4 - dialing code

Specifies the result langauge. If a candiate has specific aliases, they will be returned in this language. Legal values are the ISO 639-2 language codes.

Tolerance for reverse geocoding. The reference is the best matching candidate; all other candidates that are within a certain distance are also returned. The search will be tolerant for value greater than 100 (= 100%). As an example, a value of 200 will return all candidates with a maximum distance twice of the best matching candidate.

Any value less or equal than 100 switches off the tolerance mode. Instead the engine will try to find as many candidates as set by ENGINE_TARGETSIZE.

The reverse geocode engine tries to find up to TargetSize candidates. This parameter is of type integer.

Specifies the way how xLocate will filter the reverse locating results. Possible values:

• 0 - filters nothing
• 1 - filters results where the street has no name
• 2 - filters streets without a name and duplicate street results.

The distance to search for results, measured in meters. Special value is -1 for searching only the next result. The default value is -1.

The detail level to search for. Two values are supported:

• 0 - detail level street.
• 1 - detail level city.

Sets the minimal population a city must have to be returned on search detail level city. Legal values:

• 0:  no filter
• 1:  return all results < 100
• 2:  100 - < 200
• 3:  200 - < 500
• 4:  500 - < 1,000
• 5:  1,000 - < 2,000
• 6:  2,000 - < 3,000
• 7:  3,000 - < 5,000
• 8:  5,000 - < 10,000
• 9:  10,000 - < 20,000
• 10: 20,000 - < 50,000
• 11: 50,000 - < 100,000
• 12: 100,000 - < 250,000
• 13: 250,000 - < 500,000
• 14: >= 500,000

Specifies the minimum size of the result list. If for instance the minimum size is set to 1 and no results are found within a given search distance, then the search will be continued with a larger search range until a result is found.
This parameter is of type integer.

If true, all results with exactly the same distance will be returned even if the target size is exceeded. For instance the target size is 5 and the results at positions 4 to 7 in the result list have the same distance. Then all seven results will be returned. The list will be truncated to five otherwise.
This parameter is of type boolean.

The type of country code used for geocoding. Legal values are non negative integer values:

• 0 - Country name
• 1 - ISO2
• 2 - ISO3
• 3 - country code plate
• 4 - dialing code

If true, binary search is enabled when searching address candidates. This is a parameter of type boolean.

If true, phonetic search is enabled when searching address candidates. This is a parameter of type boolean.

If true, fuzzy search is enabled when searching address candidates. This is a parameter of type boolean.

Specifies, where to search for house numbers in the street field. Legal values are non negative integer values:

• 0 - do not search for house numbers.
• 1 - search at the beginning.
• 2 - search at the end.
• 3 - search at the beginning and at the end.

If true, that all house number ranges are returned. This is a parameter of type boolean.

Specifies the result language. If a candidate has specific aliases, they will be returned in this language. Legal values are the ISO 639-2 language codes.

If true, all city districts are returned. This is a parameter of type boolean.

Deprecated as of version 1.17. The search engine will ignore the parameter.

Specifies if postcodes should be aggregated. This is a parameter of type boolean.

Deprecated as of version 1.17. The search engine will ignore the parameter.

Enable or disable intersection search. This is a parameter of type boolean.

This value describes the distance in meter used to move the coordinates away from streets when interpolating house numbers. This parameter is of type integer.

Limits the number of results.

Specifies one or more separators for the search with the methods findAddressByText() and findObjectByText().The separators can be listed with or without blanks. Not allowed is just a blank as value. A search without a separator is possible.

Supported by:

• findAddressByText()
• findObjectByText()

Enables/Disables address search for the findObjectByText(). This option is enabled by default. Any other function will ignore this setting.

Enables/Disables combined transport search for the findObjectByText(). This option is enabled by default. Any other function will ignore this setting.

The results are sorted in ascending order.

The results are sorted in descending order.

The left top corner point.

The right bottom corner point.

Specifies how many requests have still to be calculated.

The number of successful calculations so far.

The number of failed computations so far.

The current action being executed. For more information on progress see About Asynchronous Protocol.

The progress of the distance matrix calculation, available only if action equals "DistanceMatrix.Calculation".

The progress of the optimization, available only if action starts with "Optimization.".

The unique key to identify the distance matrix currently being calculated.

The 1-based index of the distance matrix currently being calculated. Depending on the number of different vehicles in the request the number of distance matrices to be calculated can be greater than

The index of the last distance matrix to be calculated, that is the total number of distance matrices.

The progress of the distance matrix currently being processed, available only if action equals "DistanceMatrix.Calculation".

The 1-based index of the current row of the current distance matrix being calculated.

The index of the last row of the current distance matrix to be calculated.

If not null, this attribute contains the well-known binary encoded form of the geometry

If not null, this attribute contains the well-known text encoded form of the geometry

If not null, this attribute contains the well-known text encoded form of the geometry

If not null, this attribute contains the explicit form of the geometry

The available machine time stated in the request in [s]. This value is 0 if available machine time is not set in the request.

The machine time already used in [s].

The index of this iteration. Index 0 denotes the initial plan directly after construction or the input plan.

The number of improvements the algorithm has already achieved. In other words, this is the number of tour plans with a smaller value of costOfObjectiveFunction than the best one at that time.

The key figures characterizing the current tour plan.

The key figures characterizing the currently best tour plan.

The key figures characterizing the initial tour plan. The initial tour plan is the input plan, if available, or the first tour plan after the construction step.

This id references the background job on the server.

The current status of the job.

The current progress of the job. Can be null at the very beginning or very end of the request execution.

Elapsed time since this job has been queued.

The KML string itself.

The placemarks of the KML. If empty, all placemarks will be used. This will result in a GeometryCollection, if more than one exists.

The optimization aims at minimizing the objective function. This value contains its arithmetical cost.

The significance of this value is not the value itself, but rather if and how fast it decreases during the calculation. The faster the value decreases the better the tour plans become according to the GoalImportance which defines what "better" means, at all.

The number of orders already being scheduled.

The number of orders not being scheduled, yet. These orders are feasible and can be scheduled during further improvement iterations.

The number of orders not being scheduled. These orders are infeasible and will not be scheduled during further improvement iterations.

The number of vehicles being scheduled.

The number of all planned tours.

The sum of the tour periods for all planned tours ([sec]).

The sum of the tour driving periods for all planned tours ([sec]).

The sum of the tour waiting periods for all planned tours ([sec]).

The sum of the tour distances for all planned tours ([m]).

The sum of the tour costs for all planned tours ([MU]). The costs per chain will not be included, see attribute totalChainCosts.

The sum of the costs per chain of all planned chains ([MU]). See VehicleCosts.

The sum of the chain periods of all planned chains ([sec]). The chain period is defined as the period between the start of the first tour and the end of the last tour. This period is greater than the sum of the periods of all tours if two subsequent tours do not start right after the other.

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

The index of the current loop being calculated.

The index of the last loop being calculated. The calculation will automatically be finished by the algorithm before reaching this index when no improvement could be reached, anymore. The total number of loops can be set for the improvement step, only (see Params).

The progress in % of the current loop being calculated.

The set of geometries making up the geometry collection.

The set of points defining the line string.

The set of points defining the linear ring.

The set of line strings making up the multi line string.

The set of points making up the multi point.

The set of polygons making up the multi polygon.

The x coordinate

The y coordinate

The z coordinate (optional, only if requested)

The set of linear rings making up the polygon.

The current action being executed. For more information on progress information see About Asynchronous Protocol.

The progress of the distance matrix calculation, available only if action starts with "DistanceMatrix.".

The progress of the improvement step during the tour plan optimization, available only if action equals "Optimization.Improvement".

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

The coordinate format used in the request/response.

The geometry encoding for the response.

The name of the parameter profile to be used.

For internal use only.

If the coordFormat equals to 'OG_SRID', this attribute contains the Spatial Reference Identifier as specified by the Open Geospatial Consortium (OGC), otherwise it is null. All codes of the EPSG Geodetic Parameter Dataset V7.9 maintained by the EPSG.

The current action being executed. For more information on progress with territory planning see the use case documentation.

The progress of the distance matrix calculation, available only if action equals "DistanceMatrix.Calculation".

The progress of the optimization, available only if action starts with "TerritoryOptimization.".

If defined this optional parameter enables additional progress updates with the specified interval. If no new progress update arrives during the specified period, watchJob will wait for and return with the next available progress update. Important updates such as terminal states will always return immediately. The minimum period must be at least 250ms. If no progress waiting period is defined, progress will only be sent as part of status updates.

Specifies the timeout after which watchJob will report the last status even if no further updates are available.If not specified a configured default is used.

The current action being executed.

The progress of the optimization, available only if action starts with "LoadingSpaceOptimization.".

OpenGIS representation of WGS 84 coordinates. Example x=8.2505556, y=48.7627778.

PTV representation of coordinates by degree, minute, and second. Example x=815020, y=4845460.

PTV representation of WGS 84 coordinates. Example x=825056, y=4876278.

PTV representation of conform coordinates. Example x=1672358, y=1620743.

PTV representation of super-conform coordinates. Example x=5072358, y=3320743.

PTV internal coordinate format. Example x=4352286, y=5456405.

This format is set implicitly, if a Spatial Reference Identifier as specified by the Open Geospatial Consortium (OGC) is set in the CallerContext. All codes of the EPSG Geodetic Parameter Dataset V7.9 maintained by the EPSG..
Note: The coordinate format 'OG_GEODECIMAL' and the SRID code 'EPSG:4326' are equivalent.

The specified WKT in the request is invalid. It should a well-known text representation of a geometry from a string (see the OpenGIS simple features specification).

The specified WKB in the request is invalid. It should be a geometry from a byte stream in well-known binary format.

The specified KML in the request is invalid.

Thrown, if requested placemark name is not found in the KML

One or more geometry objects in the request are invalid. There are problems to convert a geometry object to a plain geometry object. Also used for retrieving the plain geometry object from a geometry object.

There are problems to convert a CoordFormat of the request to a coordinate type.

Geometry objects cannot be encoded.

Plain geometry encoding using structured objects and according network presentation.

Geometry should be represented by well-known binaries.

Use well-known texts to encode geometry objects.

Use Keyhole Markup Language to encode geometry objects.

Job has been enqueued.

Job is currently running.

Stop has been requested, the job will terminate its calculation as soon as possible.

Job has completed successfully.

Job has failed with an exception.

The job was deleted by the user.

The job is in an unknown state. For example a given id is unknown or the job has already been fetched and has thus been deleted from the underlying persistent store.