Bahrain (BHR)
This chapter defines the supported Geocode datasets, operations, and input and output field information for Bahrain.
Supported Geocode Datasets
The following table lists the supported Geocode dataset(s) with the available geocoding levels for Bahrain.
Geocode Dataset | Maximum Precision | Postcodes | Language | Geocode Level |
---|---|---|---|---|
TomTom | Street Centroid | No |
Arabic,latinized Arabic |
Premium & Advanced |
NAVTEQ | Address Points | No | Arabic,latinized Arabic | Premium |
Supported Operations
The following operations are supported for Bahrain:
- 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 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:
Manama Centre Building |
areaName1 | String | Not used. |
areaName2 | String | Not used. |
areaName3 | String | Specifies the city or town. Optional. |
areaName4 | String | Not used. |
postalCode | String | Specifies the 3- or 4-digit postal code. Optional. |
country | String | ISO 3166-1 Alpha-3 country code or country name. For Bahrain, the country code is BHR. Required for forward geocoding. |
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][postal_code]
- [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.
- [postal_code] is the postal code.
- Either the [area] or [postal_code] is required.
Custom Options
There are no options specific to Bahrain.
Parsed Address Output Fields
The following table lists the parsed address fields returned for a candidate located in Bahrain.
To return the Parsed Address fields, send the returnAllCandidateInfo
preference true
in POST request.
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 | 3- or 4-digit postal code. |
postCode2 | Not used. |
country | The three-letter ISO 3166-1 Alpha-3 country code. For Bahrain, the country code is BHR. |
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 | Bahrain does not have any custom output fields. |