City Information

About 244 wordsLess than 1 minute

GET City API

GET /v1.0/static/city/

Request Parameters

Name	Type	Required	Description
countryId	string	Yes	Country ID

Request Example

curl -X GET "{{domain}}/v1.0/static/city/1"
-H "Authorization: PHT apikey={{api_key}},signature={{signature}},timestamp={{timestamp}}"
-H "api_key : {{api_key}}"
-H "shared_secret : {{shared_secret}}"

Response Example

{
  "responseStatus": "SUCCESS",
  "version": "v1.0",
  "cityInfo": {
    "countryId": 1,
    "cities": [
      {
        "cityId": 1,
        "cityNameCn": "北京",
        "cityNameEn": "Beijing",
        "provinceId": 1,
        "provinceNameCn": "北京",
        "provinceNameEn": "Beijing"
      },
      {
        "cityId": 2,
        "cityNameCn": "上海",
        "cityNameEn": "Shanghai",
        "provinceId": 2,
        "provinceNameCn": "上海",
        "provinceNameEn": "Shanghai"
      },
      {
        "cityId": 3,
        "cityNameCn": "天津",
        "cityNameEn": "Tianjin",
        "provinceId": 3,
        "provinceNameCn": "天津",
        "provinceNameEn": "Tianjin"
      },
      {
        "cityId": 4,
        "cityNameCn": "重庆",
        "cityNameEn": "Chongqing",
        "provinceId": 4,
        "provinceNameCn": "重庆",
        "provinceNameEn": "Chongqing"
      },
      {
        "cityId": 5,
        "cityNameCn": "哈尔滨",
        "cityNameEn": "Harbin",
        "provinceId": 5,
        "provinceNameCn": "黑龙江",
        "provinceNameEn": "Heilongjiang"
      }
    ]
  },
  "remark": ""
}

Field	Type	Required	Description
responseStatus	string	Yes	Response status
version	string	Yes	API version
remark	string	No	Additional remarks
cityInfo	object	Yes	City information
countryId	string	Yes	Country ID
cities	List	Yes	List of cities
cityId	int	Yes	City ID
cityNameEn	string	Yes	City name (English)
cityNameCn	string	Yes	City name (Chinese)
provinceId	int	No	Province ID
provinceNameCn	string	No	Province name (Chinese)
provinceNameEn	string	No	Province name (English)

Status Codes

Code	Description
SUCCESS	Request successful
NO_FIND	No data found
UNAUTHORIZED	Authentication failed
SUPPLIER_SERVER_ERROR	Server or upstream API error