Vietnam (VNM)

This section defines the supported geocoding datasets, operations, and input and output field information for Vietnam.

Supported Geocoding Datasets

The following table lists the supported geocoding dataset(s) with the available geocoding levels for Vietnam.

Note: Custom User Dictionaries are supported.
Geocoding Dataset City Centroid Suburb/Village Centroid Postal Centroid Street Centroid Interpolated Street Address Point-level Address Point of Interest
TomTom Vietnamese Yes Yes No Yes Yes Yes Yes

Supported Operations

The following operations are supported for Vietnam:
  • Geocoding—Takes one or more addresses as input and returns latitude/longitude coordinates and other information.
  • Reverse Geocoding—Takes one or more latitude and longitude coordinates as input and returns the address of the location.
  • Interactive Geocoding— Returns potential match candidates as the adddress is typed in.
  • Global Key Lookup—Returns geocode candidates when given a unique key as input. USA MLD and AUS GNAF data only.

Input Fields

The input address may contain some or all of the following address elements.

Parameter Type Description
placeName String Specifies the building name, place name, Point of Interest (POI), company or firm name associated with the input address. Optional.
mainAddress String Single Line Input—If no other address field is populated, then the mainAddress entry will be treated as a single line input. Single line input can consist of multiple input address fields ; these should be entered in the typical address order for the country. For more details, refer to the section "Single Line Input" below.

Street Address—If the post address components (city, postalCode, etc.) are provided separately or in the lastLine field, then the contents of mainAddress will be treated as the street address part and can include company name, house number, building names and street names. Optional.

Street Intersection Input—To enter an intersection, specify the two street names separated by a double ampersand (&&).
lastLine String The last line of the address. Optional. For example:

2 2 Tháng 9
Đà Nẵng
areaName1 String Specifies the province. Optional.
areaName2 String Specifies the district. Optional.
areaName3 String Specifies the precint, district or town name.
areaName4 String Not used.
postalCode String Vietnam uses a five-digit postal code beginning with a number between 1 and 9. There is typically a space between the first three digits (the outward sorting part of the postcode) and the last two digits (the inward sorting part).
country String The three-letter ISO 3166-1 Alpha-3 country code. For Vietnam, the country code is VNM. Required for forward geocoding.

Single Line Input

Instead of entering each address component in separate fields, you can enter the entire address in the mainAddress input field with the address elements ordered as follows:

[street_info][address_number][postal_code][area]

Where:
  • [street_info] consists of the street name, street type and any pre- or post-directional information (e.g. East, West, etc.). Optional.
  • [address_number] is optional.
  • [postal_code] is the postal code.
  • [area] is the city only, or city plus supporting information, such as state, province, locality.
  • Either the [area] or [postal_code] is required.

For best results, put a comma between the street information and the last address line information.

Custom Options

The following table lists the options that are unique for Vietnam. These custom fields are applicable to the Geocoding operation and are optional input parameters. For the standard set of options available to all countries and their definitions, see the chapters covering Geocode Service and Reverse Geocode Service.

Option Name Description
USE_ADDRESS_POINT_INTERPOLATION When set to true, enables address point interpolation. Default = false. Supported only in forward geocoding.
Note: The address point interpolation feature requires that you have a point-level geocoding dataset installed.

Output Fields

The following table lists the address fields returned for a candidate located in Vietnam.

Note: The placeName, addressNumber, unitType and unitValue field values are only returned when a geocoding dataset that supports street address interpolation is installed.
Field Name Description
mainAddressLine The street address which may include company name, house number, building names and street names.
addressLastLine The last line of the address.
placeName The building name, place name, Point of Interest (POI), company or firm name associated with the address.
areaName1 The province.
areaName2 The precinct or district.
areaName3 The town or city.
areaName4 Not used.
postCode1 The 5-digit postal code.
postCode2 Not used.
country The three-letter ISO 3166-1 Alpha-3 country code. For Vietnam, the country code is VNM.
addressNumber The address number.
streetName The street or road name.
unitType The unit type such as APT, STE, etc.
unitValue The unit value/number, such as "3B".
customFields Vietnam does not have any custom output fields.