目录

Response Parameters

Address

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.

AddressDetail

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.

AutocompletePrediction

Parameter

Mandatory

Type

Description

description

Yes

String

Predicted place description.

matchedKeywords

Yes

Word[]

Matching position of the entered keyword in the description.

matchedWords

Yes

Word[]

Words and their positions in the description.

ChildrenNode

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

Coordinate

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:

  • 1: national
  • 2: international
  • 3: national and international

depAndArr

No

String

Indicates whether an airport terminal is a departure or arrival terminal. The options are as follows:

  • 1: departure
  • 2: arrival
  • 3: departure and arrival

Comment

Parameter

Mandatory

Type

Description

starInfo

No

StarInfo

Rating statistics.

commentInfo

No

CommentInfo

Comment information.

CommentInfo

Parameter

Mandatory

Type

Description

total

No

int

Total number of comments.

OpeningHours

Parameter

Mandatory

Type

Description

texts

Yes

String[]

Description of weekly opening hours of a place.

periods

Yes

Period[]

Opening hours of a place.

Period

Parameter

Mandatory

Type

Description

open

Yes

TimeOfWeek

Open time.

close

No

TimeOfWeek

Close time.

Poi

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

OpeningHours

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.

  • small.jpg
  • medium.jpg
  • large.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:

  • OPEN_NOW: open
  • CLOSE_NOW: closed
  • CLOSED_TEMPORARILY: temporarily closed
  • CLOSED_PERMANENTLY: permanently closed
  • STATUS_UNKNOWN: unknown
NOTE:

This parameter is returned only by the place detail search API.

childrenNodes

No

ChildrenNode[]

Child nodes of a POI.

icon

No

String

Icon URL of a place.

comments

No

Comment

Comments on the POI.

Site

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

AddressDetail

Place details.

location

No

Coordinate

Longitude and latitude of a place.

viewport

No

CoordinateBounds

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

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

AutocompletePrediction

Description of the autocomplete place. This parameter is returned only by the search suggestion and autocomplete APIs.

StarInfo

Parameter

Mandatory

Type

Description

averageRating

No

String

Average rating.

TimeOfWeek

Parameter

Mandatory

Type

Description

week

Yes

int

  • 0: Sunday
  • 1: Monday
  • 2: Tuesday
  • 3: Wednesday
  • 4: Thursday
  • 5: Friday
  • 6: Saturday

time

Yes

String

24-hour time in hhmm format.

Word

Parameter

Mandatory

Type

Description

offset

Yes

int

Offset of a word in the description.

value

Yes

int

Word.