United Arab Emirates (ARE)
This section defines the supported geocoding datasets, operations, and input and output field information for the United Arab Emirates.
Supported Geocoding Datasets
The following table lists the supported geocoding dataset(s) with the available geocoding levels for the United Arab Emirates.
Geocoding Dataset | City Centroid | Suburb/Village Centroid | Postal Centroid | Street Centroid | Interpolated Street Address | Point-level Address | Point of Interest |
---|---|---|---|---|---|---|---|
TomTom Arabic, English | Yes | Yes | No | Yes | Yes | No | No |
Supported Operations
- 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.
Input Fields
The input address may contain some or all of the following address elements.
Field Name | Type | Description |
---|---|---|
PlaceName | String | Specifies the building name, place name, Point of Interest (POI), company or firm name associated with the input address. Optional. |
MainAddressLine | String | Single Line Input—If no other address field is populated, then the
MainAddressLine 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 MainAddressLinemainAddress 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:
Sheikh Rashid Bin Saeed St. |
areaName1 | String | Not used. |
areaName2 | String | Not used. |
areaName3 | String | Specifies the city or town. Optional. |
areaName4 | String | Not used. |
postalCode | String | Not used - the United Arab Emirates does not have a postal code system. |
country | String | The three-letter ISO 3166-1 Alpha-3 country code. For the United Arab Emirates, the country code is ARE. 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:
[address_number][street_info][area]
- [address_number] is optional.
- [street_info] consists of the street name, street type and any pre- or post-directional information (e.g. East, West, etc.). Optional.
- [area] is the city only, or city plus supporting information, such as state, province, locality. Required.
For best results, put a comma between the street information and the area information.
Custom Options
There are no options specific to the United Arab Emirates.
Parsed Address Output Fields
The following table lists the parsed address fields returned for a candidate located in the United Arab Emirates.
- To return the Parsed Address fields: In the Country Filters dropdown menu, select Global Defaults. Then, on the Return Values tab, select Parsed Address.
- To return all output fields: In the Country Filters dropdown, select Global Defaults. Then, on the Return Values tab, select Return all available information.
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 | Not used. |
areaName2 | Not used. |
areaName3 | The city or town. |
areaName4 | Not used. |
postCode1 | Not used. |
postCode2 | Not used. |
country | The three-letter ISO 3166-1 Alpha-3 country code. For the United Arab Emirates, the country code is ARE. |
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 | the United Arab Emirates does not have any custom output fields. |