Parameter | Mandatory | Type | Description |
|---|---|---|---|
countryCode | No | String | Country/Region code. |
country | No | String | Country name. |
state | No | String | Province/State. |
county | No | String | City/County. |
town | No | String | Town/District. |
settlement | No | String | Settlement place. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
countryCode | No | String | Country/Region code, which complies with ISO 3166-1 alpha-2. |
country | No | String | Country name. |
adminArea | No | String | Level-1 administrative region in a country, which is generally a province or state. |
subAdminArea | No | String | Level-2 administrative region in a country, which is generally a city. |
tertiaryAdminArea | No | String | Level-3 administrative region of a country. |
city | No | String | City name. You are advised to use this parameter. NOTE: This parameter is returned only by the reverse geocoding API. |
adminCode | No | String | Administrative region code, which is a string of 6 or 9 digits. This parameter is supported only for the Chinese mainland. NOTE: This parameter is returned only by the reverse geocoding API. For administrative regions at the province, city, or district/county level, the corresponding administrative region codes are returned. For other administrative regions, codes of the lowest administrative regions are returned. |
cityCode | No | String | City code, which is a string of 3 or 4 digits. This parameter is supported only for the Chinese mainland. NOTE: This parameter is returned only by the reverse geocoding API. The city code is returned only for the administrative region at the city, district/county, or town/street level. |
locality | No | String | City. |
subLocality | No | String | District or county. |
streetNumber | No | String | Street number. |
thoroughfare | No | String | Street name. |
postalCode | No | String | Postal code. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
siteId | Yes | String | ID of a place. |
name | Yes | String | Name of a place. |
formatAddress | Yes | String | Formatted detailed address of a place. |
location | Yes | Longitude and latitude of a place. | |
hwPoiTypes | Yes | String[] | Huawei classification system. |
domeAndInt | No | String | Indicates whether an airport terminal is a national or international terminal. The options are as follows:
|
depAndArr | No | String | Indicates whether an airport terminal is a departure or arrival terminal. The options are as follows:
|
Parameter | Mandatory | Type | Description |
|---|---|---|---|
starInfo | No | Rating statistics. | |
commentInfo | No | Comment information. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
texts | Yes | String[] | Description of weekly opening hours of a place. |
periods | Yes | Period[] | Opening hours of a place. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
poiTypes | Yes | String[] | List of Huawei POI types. The value range is the same as that of LocationType. NOTE: hwPoiTypes is recommended. |
hwPoiTypes | Yes | String[] | Huawei POI classification system. For details about the value range, please refer to HwLocationType. |
phone | No | String | Phone number. |
internationalPhone | No | String | International phone number. |
rating | No | double | Rating. |
websiteUrl | No | String | Website URL. |
openingHours | No | Opening hours. | |
photoUrls | No | String[] | Photo URL. There are three photo specifications: small, medium, and large. The photo is accessed by combining the URL with a photo specification, for example, photoUrl/small.jpg.
|
priceLevel | No | int | Price level. The value ranges from 0 to 4. NOTE: This parameter is returned only by the place detail search API. |
businessStatus | No | String | Business status of a place. The options are as follows:
NOTE: This parameter is returned only by the place detail search API. |
childrenNodes | No | Child nodes of a POI. | |
icon | No | String | Icon URL of a place. |
comments | No | Comments on the POI. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
siteId | Yes | String | Unique ID of a place. |
name | No | String | Name of a place. |
formatAddress | Yes | String | Formatted detailed address of a place. |
aoiFlag | No | boolean | Indicates whether a place is an AOI (POI with the plane attribute). The value true indicates yes. NOTE: This parameter is returned only by the reverse geocoding API. |
address | Yes | Place details. | |
location | No | Longitude and latitude of a place. | |
viewport | No | Viewport of a place. NOTE: This parameter is not supported for the search suggestion API. | |
distance | No | double | Linear distance between a predicted place and the location specified by the input parameter location, in meters. NOTE: Currently, this parameter is supported only for the keyword search, nearby place search, and search suggestion APIs. |
poi | No | POI information about a place if the place is a POI. | |
utcOffset | No | int | Difference between the time zone of a place and the UTC time zone, in minutes. NOTE: This parameter is returned only by the place detail search API. |
prediction | No | Description of the autocomplete place. This parameter is returned only by the search suggestion and autocomplete APIs. |