# 境外行政区划分页查询

# 1.接口说明

名称	描述
功能	境外行政区划分页查询
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
uri	$API_HOST/address/query/overseaAdminDivision
method	`oversea.admin.division`
响应超时时间	5秒
调用限频	每分钟访问不超过100次，每天累计访问不超过100000次

# 2.业务参数

名称	类型	是否必填	示例	说明
ts	Long	是	1657852687	时间戳(单位:秒，请求有效期:10分钟)
method	String	是	oversea.admin.division	方法名称
entId	Long	是	1	美团企业版分配的企业id
startUniqueId	Integer	否	1001	分页查询的起始行政区id（首次查询可传入null，此后每次查询传入上次查询返回结果列表的最后一条行政区数据的uniqueId）
pageSize	Integer	是	100	单次查询行政区数量。最大不能超过200
nationUniqueId	Integer	否	1150	所属国家行政区id(分页获取某一国家下的行政区时使用)
regionTypeList	List<Integer>	否	[1,2]	行政区类型列表（1:大洲，2:国家，3:城市，99:其他行政区。可根据实际需要分页获取不同类型的行政区）
adminLevelList	List<Integer>	否	[1,2]	行政区划层级：不同国家的行政区层级可能是不一样或不连续的，例如:沙特阿拉伯的行政区层级有"4,6,9"三级。（1:大洲，2:国家，3-11:不同层级行政区）
relativeLevelList	List<Integer>	否	[1,2]	行政区划相对于国家层级：相对于国家层级是连续的，例如：沙特阿拉伯的相对国家行政区层级有"1,2,3"三级（0:国家，1-9:相对于国家的行政区层级）

# 3.业务响应

名称	类型	是否非空	示例	说明
status	Integer	是	0	接口响应编码:成功返回0，失败编码枚举值和解决方案详见第5章错误码
msg	String	否		解决方案详见第5章错误码
data	List<OverseaAdminDivisionInfo>	是		境外行政区划信息

OverseaAdminDivisionInfo字段说明

名称	类型	是否必填	示例	说明
uniqueId	Integer	是	105900063	行政区划唯一id
adCode	String	是	105900063	行政区划编号
name	String	是	巴黎	行政区划名称
nameEn	String	是	France	行政区划英文名称
regionType	Integer	是	3	行政区类型（1:大洲，2:国家，3:城市，99:其他行政区）
iataCode	String	否	"PAR"	行政区iata标准代码
adminLevel	Integer	是	5	行政区划层级：不同国家的行政区层级可能是不一样或不连续的，例如:沙特阿拉伯的行政区层级有"4,6,9"三级。（1:大洲，2:国家，3-11:不同层级行政区）
relativeLevel	Integer	否	2	行政区划相对于国家层级：相对于国家层级是连续的，例如：沙特阿拉伯的相对国家行政区层级有"1,2,3"三级（0:国家，1-9:相对于国家的行政区层级）
parentUniqueId	Integer	否	105900008	父级行政区唯一id
parentName	String	否	法兰西岛	父级行政区中文名称
nationUniqueId	Integer	否	1059	行政区所属国家唯一id
countryIso3	String	否	FRA	行政区所属国家三字码
countryIso2	String	否	FR	行政区所属国家二字码
countryName	String	否	法国	行政区所属国家中文名称
uniqueIdPath	String	否	2-1059-105900008-105900063	行政区层级关系唯一id路径
nameZhPath	String	否	欧洲/法国/法兰西岛/巴黎	行政区层级关系中文名称链条（包含当前行政区）

# 4.示例结果

{
    "status":0,
    "msg":"success",
    "data":[
      {
        "uniqueId": 1,
        "adCode": "1",
        "name": "亚洲",
        "regionType": 1,
        "iataCode": null,
        "adminLevel": 1,
        "relativeLevel": null,
        "parentUniqueId": null,
        "countryIso3": null,
        "countryIso2": null,
        "nationUniqueId": null,
        "countryName": null,
        "nameEn": "Asia",
        "parentName": null,
        "uniqueIdPath": "1",
        "nameZhPath": "亚洲"
      },
      {
        "uniqueId": 1150,
        "adCode": "1150",
        "name": "沙特阿拉伯",
        "regionType": 2,
        "iataCode": null,
        "adminLevel": 2,
        "relativeLevel": 0,
        "parentUniqueId": 1,
        "countryIso3": "SAU",
        "countryIso2": "SA",
        "nationUniqueId": 1150,
        "countryName": "沙特阿拉伯",
        "nameEn": "Saudi Arabia",
        "parentName": "亚洲",
        "uniqueIdPath": "1-1150",
        "nameZhPath": "亚洲/沙特阿拉伯"
      },
      {
        "uniqueId": 1150000081,
        "adCode": "1150000081",
        "name": "利雅得",
        "regionType": 3,
        "iataCode": "RUH",
        "adminLevel": 6,
        "relativeLevel": 2,
        "parentUniqueId": 1150000005,
        "countryIso3": "SAU",
        "countryIso2": "SA",
        "nationUniqueId": 1150,
        "countryName": "沙特阿拉伯",
        "nameEn": "Riyadh governorate",
        "parentName": "利雅得省",
        "uniqueIdPath": "1-1150-1150000005-1150000081",
        "nameZhPath": "亚洲/沙特阿拉伯/利雅得省/利雅得"
      }
    ]
}

# 5.错误码

代码	错误描述	排查问题建议
-1	内部服务异常	可联系美团企业版对接人员，协助排查具体原因
10000	token不合法	参考：token不合法
11000	方法名和请求接口不匹配	请确认请求中的"method"参数是否与接口说明中method指定方法名一致
11001	鉴权失败，无接口访问权限	访问接口未授权，需要联系美团企业版对接人员，协助开通相关接口权限
11005	content不合法	传入参数不是标准的Object类型，调用方可通过Json工具确认
11010	ts缺失或ts时间已过期	ts(时间戳)单位:秒，参数为空，或者ts时间戳超过10分钟，已经过期，需重新获取最新时间戳
12000	访问频率过高	接口限制每分钟调用100次，超过则提示访问频率过高
30000	访问次数超过配额	接口限制每日调用10万次，超过则提示访问次数超过配额
30001	越权访问	请求参数entId不在token授权范围内，无法访问该企业数据，需要确认token和entId是否正确
101300000	请求参数校验不通过	请根据 msg 中提示内容排查传参情况，仔细核对参数名称、类型和必填要求是否与接口文档中匹配。如：pageSize 单次分页查询数量不能超过200

← 中国行政区划查询