# Get information on provincial urban areas

Debugging Tools

Interface should be called on the server side, not in the front end (Weixin Mini Program, web pages, APP, etc.) directly called, specific reference interface call guide

Interface English name: getdistrictlist

This interface is used to obtain provincial urban information

# 1. How to call

# HTTPS calls

GET https://api.weixin.qq.com/wxa/get_district?access_token=ACCESS_TOKEN

# Cloud Calls

  • This interface does not support cloud calls

# Third party invocation

  • This interface supports Third Party Platform generation business call.

  • This interface belongs to the permission set id: 8-10,13,37

  • When a service provider is authorized by one of the permissions set, it can call on behalf of the merchant by using authorizer_access_token , which can be viewed in the third-party call documentation.

# 2. Request parameters

# Query parametersQuery String parameters

Parameter NametypeRequired to fill inIntroductions
access_tokenstringyesInterface invocation credentials, using access_token , authorizer_access_token

# Request BodyRequest Payload

nothing

# 3. Return Parameters

# Response Payload

Parameter NametypeIntroductions
statusnumberStatus code
messagestringStatus Description
data_versionstringData version
resultobjarrayData content. This array is a two-dimensional array representing information from each province and city.

# Res.result(Array)Object Payload

Data content. This array is a two-dimensional array representing information from each province and city.

Parameter NametypeIntroductions
idstringDistrictid, also known as districtid
namestringSummary names of provincial urban areas
fullnamestringFull name of provincial urban areas
pinyinarrayList of provincial urban spellings
locationobjectcoordinate
cidxnumarrayAll ID of the subordinate region, which can be obtained from the subordinate region

# Res.result(Array).locationObject Payload

coordinate

Parameter NametypeIntroductions
latstringLatitude coordinates
lngstringCoordinates of longitude

# 4. Note

There are no special considerations for this interface

# 5. Code examples

Example Requests

{}

Return an example

{
"status": 0,
"message": "query ok",
"data_version": "20170510",
"result": [
    [{
      "id": "440000",
      "name": "广东",
      "fullname": "广东省",
      "pinyin": [ "guang", "dong"],
      "location": {
        "lat": 23.13171,
        "lng": 113.26627
      },
      "cidx": [246,266]
    }],
    [{
      "id": "440100",
      "name": "广州",
      "fullname": "广州市",
      "pinyin": [ "guang","zhou" ],
      "location": {
        "lat": 23.12908,
        "lng": 113.26436
      },
      "cidx": [1667,1677]
    }],
    [{
      "id": "440105",
      "fullname": "海珠区",
      "location": {
        "lat": 23.08331,
        "lng": 113.3172
      }
    },{
      "id": "440106",
      "fullname": "天河区",
      "location": {
        "lat": 23.12463,
        "lng": 113.36199
      }
    }]
  ]
}

# 6. Error code

The following is a list of error codes for this interface, other error codes can refer to General error codes

Error codeError DescriptionSolutions
40001invalid credential  access_token isinvalid or not latestAppSecret error while getting access_token, or access_token is invalid.Developers should check that AppSecret is correct, or that they are calling interfaces for the appropriate Official Account

# 7. Scope of application

How this interface can be invoked under different account types:
Weixin Mini Program Official Account Service Account
  • ✔: The account can call this interface
  • Other account types that are not expressly stated may not be called on this interface without special instructions;