城市编码

静态城市信息查询

接口URL

/static_city/list

请求参数定义

参数名	参数说明	必填	参数类型	长度	值举例	备注
CorpCode	企业账号	Y	String		1000	系统提供的企业账号
Timestamp	时间戳	Y	String	14	20180811113019	服务方仅允许20分钟内的时间误差。
Version	版本号	Y	String		3.0	固定为3.0。
ServiceType	业务城市	Y	String		0	0:所有城市、1:国内业务城市、2:国际/中国港澳台业务城市
ContainAreaFlag	是否返回区信息	N	String		0	默认0：不包含地级市的区数据，1：包含地级市的区数据
CityIdList	城市Id列表	N	List<String>	50	156110100	List最大长度50
Size	每页条数	Y	String		1	范围1-200
PageIndex	查询的页码	Y	String		1	页码, 从1开始

响应参数定义

参数名	参数说明	必填	参数类型	长度	值举例	备注
ResultCode	返回码	Y	String		0	0表示成功，其他值为失败。
Description	描述	Y	String		Success	描述信息，出错时为错误信息即错误原因。
PageIndex	当前的页码	N	String
Size	每页条数	N	String
Total	总记录数	N	String
CityList	城市编码	N	List<OpenApiCityData>
DataVersion	数据版本日期	N	String		20230302	当城市数据变化时，版本日期才会变化

OpenApiCityData

参数名	参数说明	必填	参数类型	长度	值举例	备注
CityId	城市Id	Y	String		156110100
CityName	城市中文名	Y	String		北京
CityNameEn	城市英文名	Y	String		Beijing
City3Code	城市三字码	Y	String		BJS
Country2Code	国家二字码	Y	String		CN
CountryId	国家Id	Y	String		156
CountryName	国家中文名	Y	String		中国
CountryNameEn	国家英文名	Y	String		China
CityLevel	城市等级	N	String		city	city: 市, county: 县, area: 区
BelongCityId	归属城市Id	N	String		156110100
ProvinceId	省份Id	N	String		156110000
ProvinceName	省份中文名	N	String		北京
ProvinceNameEn	省份英文名	N	String		Beijing
AreaID	国家所属洲ID	Y	String		11
AreaENName	国家所属洲英文名	Y	String		ASI
AreaCNName	国家所属洲中文名	Y	String		亚洲
LastModifyTime	最后修改时间	Y	String		20180811113019	yyyyMMddHHmmss

样例

请求示例

{
  "CorpCode": "5980",
  "Timestamp": "20220829105534",
  "Version": "3.0",
  "PageIndex": "1",
  "Size": "1",
  "ServiceType": "1",
  "ContainAreaFlag": "0",
  "CityIdList": [
      "156110100"
  ]
}

响应参数

{
  "ResultCode": "0",
  "Description": "success",
  "PageIndex": "1",
  "Size": "1",
  "Total": "2218",
  "CityList": [
    {
      "CityId": "156110100",
      "CityName": "北京",
      "CityNameEn": "Beijing",
      "City3Code": "BJS",
      "Country2Code": "CN",
      "CountryId": "156",
      "CountryName": "中国",
      "CountryNameEn": "China",
      "CityLevel": "city",
      "BelongCityId": "156110100",
      "ProvinceId": "156110000",
      "ProvinceName": "北京",
      "ProvinceNameEn": "Beijing",
      "AreaID": "11",
      "AreaENName": "ASI",
      "AreaCNName": "亚洲",
      "LastModifyTime": "20180811113019"
    }
  ],
  "DataVersion": "20230302"
}