PTV Navigator Remote Interface Documentation
Variables

Geocode a given address (retrieve the position)

Variables

final int MSG_RI_GEOCODE = 500

Detailed Description

Geocode a given address

Geocode (return geocoded address and the mercator position) from a given address.

The quality of the result will be returned as a string describing the quality (available from version >= 1.1.87):

Quality

Description

Town The town was found (the town matched in the way that the result town starts with the searched town string), the street and the house number does not match
Street The town and the street matched (the street matched in the way that the result street starts with the searched street string), the house number not
HouseNumber Town, Street and the house number matched
Unknown Nothing has matched

Sending bundle:

Not all keys have to be set to get a valid result.

KeyValueType

Info

CC The country code of the country to search in (e.g. "DE") String
PostCode The postcode to search for String
TownName The town name to search String
StreetName The street name to search String
HNr The house number to search for String


Compatibility mode (MSG_RI_SET_COMPATIBILITY_MODE) set to true:

Returned bundle:

KeyValueType

Info

PosX The found mercator x position of the address int
PosY The found mercator y position of the address int
CC The found country code String
PostCode The found postcode String
TownName The found town name String
StreetName The found street name String
HNr The found house number String
Quality The quality of the result, see Quality values for details String


Compatibility mode (MSG_RI_SET_COMPATIBILITY_MODE) set to false:

Returned bundle:

KeyValueType

Info

Longitude The longitude of the address double
Latitude The latitude of the address double
CC The found country code String
PostCode The found postcode String
TownName The found town name String
StreetName The found street name String
HNr The found housenumber String
Quality The quality of the result, see Quality values for details String

Returned error codes:

RI_ERROR_NONE if everything is ok.
RI_ERROR_INVALID_PARAMETER if the received bundle is empty.
RI_ERROR_RI_DISABLED if the Remote Interface service is disabled and/or not licensed.
RI_ERROR_NOT_INITIALIZED if the Remote Interface service is not initialized yet.
RI_ERROR_NO_RESULT_FOUND if the address couldn't be found.
RI_ERROR_NO_STREET_FOUND and a bundle of data if the search succeeded, but no street was found (return position is the town center).
RI_ERROR_NO_LICENSE if the navigator has no valid license.


© PTV Logistics 2024 Generated on Tue May 27 2025 16:37:35 for PTV Navigator Remote Interface Documentation by doxygen 1.7.3