You are on page 1of 17

ICS 35.240.

99
发芽,早三
CCS L 72
备案号:
MZ
中 华 人 民 共 和 国 民 政 行 业 标 准
MZ/T 164—2020

地名信息库数据访问接口规范
Data Access interface specification for database of geographical names

2020-12-22 发布 2020-12-22 实施

中华人民共和国民政部 发布
MZ/T 164—2020

目 次

前 言 .............................................................................................................................................................. II
1 范围...............................................................................................................................................................1
2 规范性引用文件 ...........................................................................................................................................1
3 术语和定义...................................................................................................................................................1
4 接口访问方法描述 .......................................................................................................................................2
4.1 总体描述 ...........................................................................................................................................2
4.2 坐标系 ...............................................................................................................................................2
4.3 数据类型 ...........................................................................................................................................2
4.4 请求报文定义 ...................................................................................................................................2
4.5 响应报文定义 ...................................................................................................................................3
4.6 状态码定义 .......................................................................................................................................4
4.7 接口访问步骤 ...................................................................................................................................4
5 数据访问接口 ...............................................................................................................................................5
5.1 地名查询接口 ...................................................................................................................................5
5.2 地名标志查询接口 ...........................................................................................................................6
5.3 地名明细信息获取接口 ...................................................................................................................7
5.4 地名标志明细信息获取接口 ...........................................................................................................9
5.5 行政区划基础数据查询接口 .........................................................................................................10
5.6 地名类别基础数据查询接口 ......................................................................................................... 11
5.7 附件获取接口 .................................................................................................................................12
参 考 文 献 .......................................................................................................................................................13

表 1 数据类型 .................................................................................................................................................. 2
表 2 Get 方法的接口访问方式 ....................................................................................................................... 2
表 3 Post 方法的接口访问方式 ...................................................................................................................... 3
表 4 响应报文解码后 JSON 数据结构 .......................................................................................................... 3
表 5 响应报文解码后状态码含义说明 .......................................................................................................... 4
表 6 地名查询接口请求参数 .......................................................................................................................... 5
表 7 地名查询接口响应参数 .......................................................................................................................... 5
表 8 地名标志查询接口请求参数 .................................................................................................................. 6
表 9 地名标志查询接口响应参数 .................................................................................................................. 7
表 10 地名明细信息获取接口请求参数 ........................................................................................................ 7
表 11 地名明细信息获取接口响应参数 ........................................................................................................ 8
表 12 地名标志明细信息获取接口请求参数 ................................................................................................ 9
表 13 地名标志明细信息获取接口响应参数 ................................................................................................ 9
表 14 行政区划基础数据查询接口请求参数 .............................................................................................. 10
表 15 行政区划基础数据查询接口响应参数 ...............................................................................................11
表 16 地名类别基础数据查询接口请求参数 ...............................................................................................11
表 17 地名类别基础数据查询接口响应参数 ...............................................................................................11
表 18 附件获取接口请求参数 ...................................................................................................................... 12

I
MZ/T 164—2020

前 言

本文件按照 GB/T 1.1—2020《标准化工作导则第 1 部分:标准化文件的结构和起草规则》的规定


起草。
请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。
本文件由中华人民共和国民政部提出。
本文件由全国地名标准化技术委员会(SAC/TC233)归口。
本文件起草单位:民政部区划地名司、厦门精图信息技术有限公司。
本文件主要起草人:黄智晖、朱永强、杨刚、龚发芽、卢艇、贺延伟、田瑜基、黄萍萍、田铮、林
仙梅、郭燕滨、胡鹏飞。
本文件为首次发布。

II
MZ/T 164—2020

地名信息库数据访问接口规范

1 范围

本文件规定了地名信息库的接口访问方法和数据访问接口。
本文件适用于各级地名主管单位及其他委办局或科研单位与地名信息库的数据对接。

2 规范性引用文件

下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,
仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本
文件。
GB/T 2260 中华人民共和国行政区划代码
GB/T 10114—2003 县以下行政区划代码编制规则

3 术语和定义

下列术语和定义适用于本文件:
3.1
地名代码 codes for geographical names
地名代码是表示一条地名的唯一标识码。地名代码一般由地名所在的县级以上行政区划代码加县级
以下行政区划代码加地名类别代码加顺序号四段数字组成,共有 20 位数字。
[来源:MZ/T 162—2020,7.1.2,有修改]
3.2
地名标志代码 codes for signs of geographical names
地名标志代码是表示一条地名标志的唯一标识码。地名标志代码由地名标志所对应地名的地名代码
加顺序号组成,共有 22 位数字。
[来源:MZ/T 162—2020,7.1.3,有修改]
3.3
JSON Javascript Object Notation
JSON 是一个轻量级的,基于文本的,跨语言的数据交换格式。JSON 定义了一组用于表示结构化数
据的可移植的格式化规则。
[来源:RFC4627]
3.4
WKT Well known text
WKT(Well-known text)是一种文本标记语言,用于表示矢量几何对象、空间参照系统及空间参照系
1
MZ/T 164—2020

统之间的转换。
[来源:OGC12—063r5]
3.5
Token
本文件的 Token 是指由服务端生成的一段字符串,该字符串作为客户端进行请求的令牌,服务端通
过客户端携带的令牌,实现对客户端身份的识别和权限的控制。

4 接口访问方法描述

4.1 总体描述

每个地名信息库数据接口对应一个唯一的 URL 网址,通过该 URL 对接口进行访问。


本文件描述的所有接口请求报文的请求头(Header)必须含有一个“Token”值,用于校验和确保
数据来源安全性。接口的请求方式包括 Get 和 Post 两种,接口的响应报文正文返回格式为 JSON 格式。

4.2 坐标系

本文件中接口所涉及空间数据均采用 2000 国家大地坐标系(CGCS2000)。

4.3 数据类型

本文件中接口的调用和数据返回使用了字符型、整型、布尔型、浮点型、日期时间型、以及
JavaScript 对象等数据类型。

表 1 数据类型

数据类型 说明

String(字符型) 通过字符形式表达的值的类型

Int(整型) 通过“0”到“9”数字表达的整数类型的值,值在-2147483648 到 2147483647 之间

Bool(布尔型) 通过 True 或 False 表达的类型

Float(浮点型) 通过“0”到“9”数字表达的实数

DateTime(日期时间型) 通过 YYYYMMDDhhmmss 的形式表达的值的类型

Object(对象类型) JavaScript 中对象数据类型

4.4 请求报文定义

表 2 Get 方法的接口访问方式

请求相关信息 示例值 描述

请求 URL 【接口所在 URL 网址】 接口所在的 URL 地址


请求方式(Method) Get
2
MZ/T 164—2020

表 2 Get 方法的接口访问方式(续)

请求相关信息 示例值 描述
用户持有的 Token,用户请求时,将
请求头 Token 【用户获取的 Token 值】 Token 放在 Header 里,用于识别用
(Header) 户和控制权限
Accept Application/json 表示数据返回 Json 类型
用户调用接口的参数,具体的值参考
请求 URL 参数 例如:Page=1&Size=10 各个接口所需的参数,所有参数直接
作为 URL 参数提交即可

表 3 Post 方法的接口访问方式

请求相关信息 示例值 描述

请求 URL 【接口所在 URL 网址】 接口所在的 URL 地址


请求方式(Method) Post
用户持有的 Token,用户请求时,将
Token 【用户获取的 Token 值】 Token 放在 Header 里,用于识别用户
请求头 和控制权限
(Header)
Content-Type Application/json 表示上传到服务端的参数类型
Accept Application/json 表示数据返回 Json 类型
用户调用接口的参数,具体的值参考
例如:{“Page”:“1”,“Size”: 各个接口所需的参数,所有参数组合
请求体(body)
“1”} 为 Json 数据格式,放到请求体
(body),作为请求提交

4.5 响应报文定义

响应报文输出参数解码后 JSON 数据结构如下:

表 4 响应报文解码后 JSON 数据结构

JSON格式定义 说明
{
"Status":…… 接口响应处理结果状态码,详见4.6 状态码定义
"Rows":…… 接口响应处理结果,Object类型
"Total":…… 接口响应处理结果集合总条数
"Message":…… 接口响应处理结果描述信息
}

3
MZ/T 164—2020

4.6 状态码定义

如上文,响应报文解码后 Status 即为状态码,不同的状态码表示不同的含义,说明如下:

表 5 响应报文解码后状态码含义说明

状态码 定义 备注
0 接口访问处理正常
1 服务端内部错误
2 接口访问权限不足 没有访问该接口的权限
3 请求报文中的参数在服务端验证不通过 传递的参数值存在问题,或缺少必填参数等
4 被限流 一定时间段内超过接口访问最大次数
5 接口访问处理失败

4.7 接口访问步骤

接口访问步骤如下:
a) 获取授权:通过地名信息库政务管理平台注册用户并对相关接口访问进行申请,经审核通过
后获取合法授权。
b) 获取接口地址:通过地名信息库政务管理平台获取接口唯一的 URL 网址。
c) 构建接口访问地址:
Get 请求 cURL 示例

cURL -X GET --header 'Accept: application/json' --header 'Token: 【用户获取的 Token 值】' 'http://【接口
对应的 URL 地址】?【接口参数 1】=【接口参数值 1】&【接口参数 2】=【接口参数值 2】’

Post 请求 cURL 示例

cURL -X POST --header 'Content-Type: application/json' --header 'Token: 【用户获取的 Token 值】' --header
'Accept: application/json' -d '{"【接口参数 1】": "接口参数值 1",”【接口参数 2】”:”【 接口参数值 2】”}' 'http://
【接口对应的 URL 地址】'

d) 接口访问:通过编码的接口访问地址访问接口,取得返回结果。

4
MZ/T 164—2020

5 数据访问接口

5.1 地名查询接口

5.1.1 接口描述

根据用户输入合法的接口访问网址和参数,对地名信息库中的地名进行查询。查询参数包括地名名
称、地名类别代码、行政区划代码、使用时间等;查询结果以 JSON 格式返回。

5.1.2 接口网址格式

http://[服务地址]/api/[版本号]/PlaceName/List

5.1.3 请求参数

请求方式:Get

表 6 地名查询接口请求参数

参数名称 是否必须 类型 约束 描述(示例)

PlaceName 否 String 小于 200 个字符 搜索的地名名称


符合地名类别代码格
PlaceTypeCode 否 String 地名类别代码

符合行政区划代码格
DistCode 否 String 行政区划代码

使用时间,“01”表示现今地名,
UseTime 否 String 01 或 02
“02”表示历史地名
Page 是 Int 大于 0 页码
Size 是 Int 大于 0 每页大小

5.1.4 响应参数

表 7 地名查询接口响应参数

参数名称 描述 类型
Status 服务状态码,值查看下述介绍 Int
Rows 接口返回的数据集合 Object[]
PlaceCode 地名代码 String
StandardName 标准名称 String
是否有坐标,0 表示无,1 表示点状
HasGeometry Int
地名,2 表示线状地名

5
MZ/T 164—2020

表 7 地名查询接口响应参数(续)

参数名称 描述 类型
Geometry 空间信息,内容为 WKT 标准格式 String
HasMedia 是否有多媒体 Bool
PlaceTypeName 地名类别全名 String
RegistrationTime 登记时间 DateTime
UpdateTime 数据更新时间 DateTime
Registranter 登记人 String
使用时间“01”表示现今地名,“02”
UseTime String
表示历史地名
DistName 完整所在区划名称 String
PlaceTypeCode 地名类别代码 String
Total 请求结果查询的总条数 Int
Message 接口返回的文本消息 String

5.2 地名标志查询接口

5.2.1 接口描述

根据用户输入合法的接口访问网址和参数,对地名信息库中的地名标志进行查询。查询参数包括地
名标志名称、地名类别代码、行政区划代码、登记人姓名等;查询结果以 JSON 格式返回。

5.2.2 接口网址格式

http://[服务地址]/api/[版本号]/PlaceSign/List

5.2.3 请求参数

请求方式:Get

表 8 地名标志查询接口请求参数

参数名称 是否必须 类型 约束 描述(示例)

PlaceName 否 String 小于 200 个字符 搜索的地名标志名称


PlaceTypeCode 否 String 符合地名类别代码格式 地名类别代码
DistCode 否 String 符合行政区划代码格式 行政区划代码
Registranter 否 String 小于 100 个字符 按登记人姓名检索
Page 是 Int 大于 0 页码
Size 是 Int 大于 0 每页大小

6
MZ/T 164—2020

5.2.4 响应参数

表 9 地名标志查询接口响应参数

参数名称 描述 类型
Status 服务状态码,值查看下述介绍 Int
Rows 接口返回的数据集合 Object[]
Code 地名标志代码 String
StandardPlaceName 地名标志名称 String
UpdateTime 数据的更新时间 DateTime
Register 登记人 String
DistName 完整的行政区划名称 String
是否有空间信息,0 表示无,1 表示
HasGeometry Int
点状数据,2 表示线状数据
HasMedia 是否包含多媒体 Bool
Total 请求结果查询的总条数 Int
Message 接口返回的文本消息 String

5.3 地名明细信息获取接口

5.3.1 接口描述

根据用户输入合法的接口访问网址和地名代码(PlaceCode),获取用户所在地的地名明细信息,查询
结果以 JSON 格式返回。

5.3.2 接口网址格式

http://[服务地址]/api/[版本号]/PlaceName/Detail

5.3.3 请求参数

请求方式:Get

表 10 地名明细信息获取接口请求参数

参数名称 是否必须 类型 约束 描述(示例)


PlaceCode 是 String 符合地名代码格式 地名代码

7
MZ/T 164—2020

5.3.4 响应参数

表 11 地名明细信息获取接口响应参数

参数名称 描述 类型

Status 服务状态码 Int


Rows 接口返回的数据集合 Object[]
PlaceCode 地名代码 String
StandardName 标准名称 String
PlaceTypeName 地名类别全名 String
RegistrationTime 登记时间 DateTime
UpdateTime 数据更新时间 DateTime
registranter 登记人 String
使用时间“01”表示现今地名,
“02”表示历史地
UseTime String

DistName 完整所在区划名称 String
PlaceTypeCode 地名类别代码 String
DistCode 所在行政区划代码 String
DistNameAll 完整的行政区划名称(包括所在省市) String
PlaceNameTypeAll 完整的地名类别(包括大类中类) String
Alias 别名 String
Abbreviations 简称 String
FormerName 曾用名 String
ChineseCharacterWriting 汉字书写 String
EthnicMinoritiesWriting 少数民族语书写 String
PlaceOriginalSound 地名原读音文件路径 String
RomanAlphabetSpelling 罗马字母拼写 String
PlaceLanguage 地名语种 String
PlaceOrigin 地名来历 String
PlaceMeaning 地名含义 String
PlaceHistory 地名历史沿革 String
EntityProfile 地理实体概况 String
MultimediaInfo 多媒体信息文件路径,多个路径间用“|”隔开 String
DataSources 资料来源以及出处 String
Comment 备注 String
GenRomemSpelling 通名罗马字母拼写 String
EstablishmentYear 设立年份 String
AbolishYear 废止年份 String
Geometry 空间信息,内容为 WKT 标准格式 String

8
MZ/T 164—2020

表 11 地名明细信息获取接口响应参数(续)

参数名称 描述 类型
Total 请求结果查询的总条数 Int
Message 接口返回的文本消息 String

5.4 地名标志明细信息获取接口

5.4.1 接口描述

根据用户输入合法的接口访问网址和地名标志代码(code),获取用户所在地的地名标志明细信息,
查询结果以 JSON 格式返回。

5.4.2 接口网址格式

http://[服务地址]/api/[版本号]/PlaceSign/Detail

5.4.3 请求参数

请求方式:Get

表 12 地名标志明细信息获取接口请求参数

参数名称 是否必须 类型 约束 描述(示例)

Code 是 String 符合地名标志代码格式 地名标志代码

5.4.4 响应参数

表 13 地名标志明细信息获取接口响应参数

参数名称 描述 类型
Status 服务状态码 Int
Rows 接口返回的数据集合 Object[]
Code 地名标志代码 String
StandPlaceName 地名标志名称 String
UpdateTime 数据的更新时间 DateTime
Register 登记人 String
DistNameAll 完整的行政区划名称(包括省市) String
Spell 汉语拼音拼写 String
NationWords 民族文字 String
Longitude 经度 Float

9
MZ/T 164—2020

表 13 地名标志明细信息获取接口响应参数(续)

参数名称 描述 类型
Latitude 纬度 Float
SetUnit 设立单位 String
SetTime 设立时间 String
ProduceVender 生产厂家 String
Material 材质 String
Norms 规格 String
标志照片的路径,多个路径用“|”隔
PicFname String

RegisterCompany 登记单位 String
DistCode 所在区划代码 String
Total 请求结果查询的总条数 Int
Message 接口返回的文本消息 String

5.5 行政区划基础数据查询接口

5.5.1 接口描述

根据用户输入合法的接口访问网址和参数,对行政区划基础数据进行查询。查询参数包括行政区划
代码、行政区划最大层级、是否包含本级行政区划等;查询结果以 JSON 格式返回。

5.5.2 接口网址格式

http://[服务地址]/api/[版本号]/Xzqh/Get

5.5.3 请求参数

请求方式:Get

表 14 行政区划基础数据查询接口请求参数

参数名称 是否必须 类型 约束 描述(示例)


符合行政区划代
Code 是 String 查询的行政区划代码

行政区划最大层级,例如:2 表
MaxDeep 否 Int 1、2、3
示获取两层的深度
是否包含本级行政区划,默认为
IncludeCurr 否 Bool

10
MZ/T 164—2020

5.5.4 响应参数

表 15 行政区划基础数据查询接口响应参数

参数名称 描述 类型
Status 服务状态码,值查看下述介绍 Int
Rows 接口返回的数据集合 Object[]
ID 数据的 ID Int
Code 区划代码 String
Name 区划名称 String
级别,0 表示国家级,1 表示省级,2 表示地市
Level Int
级,3 表示区县级,4 表示乡镇级
ParentCode 上一级区划代码 String
Children 下一级节点的数据 Object[]
Total 请求结果查询的总条数 Int
Message 接口返回的文本消息 String

5.6 地名类别基础数据查询接口

5.6.1 接口描述

根据用户输入合法的接口访问网址,直接返回所有层级的地名类别,查询结果以 JSON 格式返回。

5.6.2 接口网址格式

http://[服务地址]/api/[版本号]/placetype/get

5.6.3 请求参数

请求方式:Get

表 16 地名类别基础数据查询接口请求参数

参数名称 是否必须 类型 约束 描述(示例)


1 表示查询全部,0 表
Isall 否 Int
示查询下级

5.6.4 响应参数

表 17 地名类别基础数据查询接口响应参数

参数名称 描述 类型
Status 服务状态码,值查看下述介绍 Int

11
MZ/T 164—2020

表 17 地名类别基础数据查询接口响应参数(续)

参数名称 描述 类型
Rows 接口返回的数据集合 Object[]
Name 类别名称 String
Code 类别代码 String
Children 下一节点数据 Object[]
Total 请求结果查询的总条数 Int
Message 接口返回的文本消息 String

5.7 附件获取接口

5.7.1 接口描述

根据用户输入参数获取附件信息,附件包括照片、录音、录像、文本等多媒体信息。

5.7.2 接口网址格式

http://api/[版本号]/Attachment/Get

5.7.3 请求参数

表 18 附件获取接口请求参数

参数名称 是否必须 类型 约束 描述(示例)


返回的数据是否为缩略图,true 表示是,false
IsLite 否 Bool
表示否
所在附件的相对路径,例如:地名获取附件的
单路径长度小于
Path 是 String 字段为 MultimediaInfo,该字段中截取“|”分割
255 个字符
的即为一个附件的相对路径

5.7.4 响应参数

直接根据附件多媒体类型返回相应的附件文件流。

12
MZ/T 164—2020

参 考 文 献

[1] GB/T 17797—1999 地形数据库与地名数据库接口技术规程


[2] GB/T 32633—2016 分布式关系数据库服务接口规范
[3] GB/T 36906—2018 电子证照 共享服务接口规范

13

You might also like