LD/T 6004-2023 人力资源社会保障信息系统服务接口报文体规范
LD/T 6004-2023 The specifications for the reporting format of the Human Resources and Social Security Information System service interface
基本信息
发布历史
-
2023年11月
研制信息
- 起草单位:
- 人力资源社会保障部信息中心
- 起草人:
- 许莹莹、蒋旭卉、赵劲、马丹蕾、张加会、汪诚、李凯、李晨星、马艳婷、黄振宇、徐梓川、刘渊、李静
- 出版信息:
- 页数:21页 | 字数:- | 开本: -
内容描述
ICS35.240.01
CCSL71
备案号92461-2024
LD
中华人民共和国劳动和劳动安全行业标准
LD/T6004—2023
人力资源社会保障信息系统服务接口报文
体规范
Specificationsofmessagebodystyleforserviceinterfaceofhumanresourcesand
socialsecurityinformationsystem
2023-11-24发布2023-12-01实施
中华人民共和国人力资源和社会保障部发布
LD/T6004—2023
目次
前言II
1范围1
2规范性引用文件1
3术语和定义1
4缩略语1
5接口类型1
6报文类型2
7报文结构2
8查询接口2
请求报文体规范2
响应报文体规范3
9操作接口5
请求报文体规范5
响应报文体规范7
10接口说明文档8
11报文体加密9
12其他要求9
版本控制9
指标代码9
附录A(资料性)接口说明文档示例10
A.1返回结果为单条记录接口说明文档示例10
A.2返回结果为多条记录接口说明文档示例13
参考文献17
I
LD/T6004—2023
前言
本文件按照GB/T1.1—2020《标准化工作导则第1部分:标准化文件的结构和起草规则》的规定
起草。
请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。
本文件由人力资源社会保障部提出并归口。
本文件起草单位:人力资源社会保障部信息中心。
本文件主要起草人:许莹莹、蒋旭卉、赵劲、马丹蕾、张加会、汪诚、李凯、李晨星、马艳婷、黄
振宇、徐梓川、刘渊、李静。
II
LD/T6004—2023
人力资源社会保障信息系统服务接口报文体规范
1范围
本文件规定了人力资源社会保障信息系统服务接口报文体的推荐性设计要求,包括服务接口的技
术选型、报文类型、报文结构、报文体格式规范、接口说明文档、报文体加密和其他要求。
本文件适用于人力资源社会保障信息系统设计开发数据交换和业务协同服务接口。
2规范性引用文件
下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,
仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本
文件。
GB/T39786—2021信息安全技术信息系统密码应用基本要求
LD/T02.2—2022人力资源社会保障电子认证体系规范第2部分:电子认证系统技术规范
LD/T92—2013社会保险管理信息系统指标集与代码
3术语和定义
下列术语和定义适用于本文件。
服务接口serviceinterface
业务系统(或基础支撑平台)为其他使用方提供数据交换的一种方式,是由一系列功能封装后可被
信息系统用户直接远程调用的软件接口。
报文message
服务接口传输的数据单元,封装了业务数据记录和通讯控制信息。
报文体messagebody
报文的主体部分,包含一条或多条业务数据记录。
4缩略语
下列缩略语适用于本文件。
HTTP:超文本传输协议(HypertextTransferProtocol)
JSON:JavaScript对象简谱,是一种轻量级的数据交换格式(JavaScriptObjectNotation)
REST:表述性状态传递(RepresentationalStateTransfer)
SSL:安全套接层(SecureSocketLayer)
UTF-8:8比特万国码的可变长度字符编码(8-bitUnicodeTransformationFormat)
5接口类型
人力资源社会保障信息系统的服务接口从功能上主要分为以下类型:
a)查询接口:可根据查询条件返回数据响应结果的服务接口;
b)操作接口:可对业务数据资源进行单条增加、批量增加、修改与删除操作的服务接口。
服务接口宜采用RESTful(HTTP+JSON)协议,并借助SSL证书加密传输。
注:RESTful是一种网络应用程序的设计风格和开发方式,本文件中指符合“REST+JSON”格式的服务接口架构。
1
LD/T6004—2023
6报文类型
人力资源社会保障信息系统的服务接口,其接口报文应采用UTF-8作为字符编码,应使用JSON格式
作为输入输出标准,报文数据通常分为“对象”“数组”“对象+数组”三种类型。
7报文结构
接口报文由报文头和报文体两部分组成,报文头由信息系统(或基础支撑平台)自行定义,报文体
参照本规范定义。
8查询接口
请求报文体规范
8.1.1报文体内容
查询接口的请求报文体为查询条件信息。
根据查询条件信息的数据类型不同,可分为“对象”“数组”两种格式。
8.1.2格式要求
查询接口的请求报文体格式要求如下:
a)字段名采用字符串格式,业务数据字段参照《人力资源社会保障管理信息系统信息结构通则》
的规则使用小写字母和数字顺序号命名,其他数据字段使用英文首词字母小写的小驼峰命名
法(lowerCamelCase)命名;
b)如果查询业务场景为分页查询,查询参数中需要传入的分页参数,可采用“cpage”表示当前
页码(从1开始),“rows”表示每页记录数量;
c)如果查询条件为数组,可采用“totalCount”表示查询对象总数,“list”用于存放查询条件
的数组“[]”,数组中可以放置多个JSON对象。
8.1.3报文体格式
对象类型普通查询
普通查询是指输入查询条件,获取查询结果数据。如社会保障卡状态查询,查询条件包含社会保障
号码、姓名,请求报文体格式见示例。
示例:
{
"aac002":"4401011********236",
"aac003":"张*"
}
注1:aac002为查询条件“社会保障号码”。
注2:aac003为查询条件“姓名”。
对象类型分页查询
分页查询是指除查询条件外,还需要将查询页码、每页记录数量等信息一同提交。如养老保险缴费
情况查询,查询条件为社会保障号码、姓名,请求报文体格式见示例。
示例:
{
"aac002":"4401011********236",
"aac003":"张*",
"cpage":1,
"rows":10
2
LD/T6004—2023
}
注1:aac002为查询条件“社会保障号码”。
注2:aac003为查询条件“姓名”。
注3:cpage为当前页码。
注4:rows为每页记录数量。
数组类型批量查询
数组类型查询条件使用较少,一般在一次性查询多条记录时使用,对于数组类查询条件,需要标记
查询对象数量,将查询条件存放在list中。如一次性查询多人社会保障卡状态,查询条件包含社会保障
号码、姓名,请求报文体格式见示例。
示例:
{
"totalCount":2,
"list":[
{
"aac002":"4401011********236",
"aac003":"张*"
},
{
"aac002":"43523119********64",
"aac003":"李*"
}
]
}
注1:totalCount为查询对象总条数。
注2:list用于存放查询条件的数组“[]”,数组中可以放置多个JSON对象。
响应报文体规范
8.2.1报文体内容
查询接口的响应报文体为查询结果信息。
根据查询结果信息的数据类型不同,可分为“对象”“数组”“对象+数组”三种格式。
8.2.2格式要求
查询接口的响应报文体格式要求如下:
a)字段名采用字符串格式,业务数据字段参照《人力资源社会保障管理信息系统信息结构通则》
的规则使用小写字母和数字顺序号命名,其他数据字段使用英文首词字母小写的小驼峰命名
法(lowerCamelCase)命名;
b)如果返回结果为分页,返回参数中需要包含分页参数,可采用“totalPage”表示分页查询最
大页数;
c)如果返回结果为数组,可采用“totalCount”表示返回对象总数,“list”用于存放返回结果
的数组“[]”,数组中可以放置多个JSON对象。
8.2.3报文体格式
对象类型
普通查询一般返回一个对象数据,即一个JSON对象,返回结果可以放置在对象中。响应报文体格式
见示例。
示例:
{
3
LD/T6004—2023
"aac002":"4401011********236",
"aac003":"张*",
"aac004":"1",
"aac004desc":"男",
"aac011":"21",
"aac011desc":"大学本科",
"……":"……"
}
注1:aac004desc放置代码类型的中文释义,采用LD/T92—2013。
注2:aac011desc放置代码类型的中文释义,采用LD/T92—2013。
数组类型
分页查询、批量查询通常返回多个对象数据,需要标记返回对象数量、分页参数,将返回结果存放
在list中。响应报文体格式见示例。
示例:
{
"totalCount":2,
"totalPage":10,
"list":[
{
"aac002":"4401011********236",
"aac003":"张*",
"aab004":"北京市**公司",
"aac019":"2",
"aae030":"2010年03月**日",
"aae031":"2013年03月**日"
},
{
"aac002":"43523119********64",
"aac003":"李*",
"aab004":"杭州**公司",
"aac019":"1",
"aae030":"2013年03月**日",
"aae031":"2015年03月**日"
}
]
}
注1:totalCount为返回对象总条数。
注2:totalPage为最大分页页数。
注3:list用于存放查询结果的数组“[]”,数组中可以放置多个JSON对象。
对象+数组类型
若存在一次查询需要返回某一业务对象的多组结果数据,则使用业务系统定义的对象标识分级拼
接。如查询个人的档案信息,其结果包含该人的基本信息、特殊工种信息、工作经历等,响应报文体格
式见示例。
示例:
{
"baseInfo":{
"aac002":"4401011********236",
"aac003":"张*"
},
"workHistory":{
4
LD/T6004—2023
"totalCount":2,
"list":[
{
"aab004":"北京市***公司",
"aac019":"1",
"aae030":"2010年03月**日",
"aae031":"2013年03月**日"
},
{
"aab004":"杭州***公司",
"aac019":"1",
"aae030":"2013年03月**日",
"aae031":"2015年03月**日"
}
]
}
}
注1:totalCount为返回对象总条数。
注2:list用于存放查询结果的数组“[]”,数组中可以放置多个JSON对象。
注3:baseInfo为业务系统定义的对象标识。
注4:workHistory为业务系统定义的对象标识。
9操作接口
请求报文体规范
9.1.1报文体内容
操作接口的请求报文体为要录入、修改、删除的业务信息。
根据业务信息的数据类型,可分为“对象”“数组”“对象+数组”三种格式。
9.1.2格式要求
操作接口的请求报文体格式要求如下:
a)字段名采用字符串格式,业务数据字段参照《人力资源社会保障管理信息系统信息结构通则》
的规则使用小写字母和数字顺序号命名,其他数据字段使用英文首词字母小写的小驼峰命名
法(lowerCamelCase)命名;
b)如果业务处理条件为数组,可采用“totalCount”表示业务处理条件总数,“list”用于存放
业务处理条件的数组“[]”,数组中可以放置多个JSON对象。
9.1.3报文体格式
对象类型
一般操作型接口,其输入为一个简单对象。请求报文体格式见示例。
示例:
{
"aac002":"4401011********236",
"aac003":"张*",
"……":"……"
}
数组类型
5
LD/T6004—2023
一次性操作多条记录,需要标记操作条件数量,将所有记录的业务处理条件放在list中。请求报文
体格式见示例。
示例:
{
"totalCount":2,
"list":[
{
"aac002":"4401011********236",
"aac003":"张*",
"……":"……"
},
{
"aac002":"43523119********64",
"aac003":"李*",
"……":"……"
}
]
}
注1:totalCount为操作条件总条数。
注2:list用于存放业务处理条件的数组“[]”,数组中可以放置多个JSON对象。
对象+数组类型
适用于一次性操作某一业务对象的多组业务数据。如一次性保存个人的基本信息、特殊工种信息、
工作经历等信息,操作数据包含对象数据、数组数据,请求报文体格式见示例。
示例:
{
"baseInfo":{
"aac002":"4401011********236",
"aac003":"张*"
},
"workHistory":{
"totalCount":2,
"list":[
{
"aab004":"北京市***公司",
"aac019":"2",
"aae030":"2010年03月**日",
"aae031":"2013年03月**日"
},
{
"aab004":"杭州***公司",
"aac019":"1",
"aae030":"2013年03月**日",
"aae031":"2015年03月**日"
}
]
}
}
注1:totalCount为操作条件总条数。
注2:list用于存放业务处理条件的数组“[]”,数组中可以放置多个JSON对象。
注3:baseInfo为业务系统定义的对象标识。
注4:workHistory为业务系统定义的对象标识。
6
LD/T6004—2023
响应报文体规范
9.2.1报文体内容
操作接口的响应报文体为业务处理的结果信息,通常返回业务处理结果状态及相关数据。
定制服务
推荐标准
- T/CAME 59-2023 医院消毒供应中心建设与运行管理标准 2023-07-25
- T/STIC 110075-2022 三维心脏电生理标测系统 2022-04-15
- T/CGCPU 006-2023 I 期临床试验能力评估规范 2023-01-01
- T/CACM 1021.126-2018 中药材商品规格等级 柏子仁 2018-12-03
- T/CAMDI 101-2023 一次性使用无菌真皮层多头注射针 2023-01-30
- T/SHAAV 004-2020 犬猫物理保定操作规程 2020-04-03
- T/SHDSGY 154-2022 一次性使用脐带剪夹器 2022-11-30
- T/CAGR 006-2022 老年人营养素强化补充指南:维生素D 2022-05-06
- T/CACM 1563.2-2024 医疗机构中药药物警戒体系建设指南 2024-01-08
- T/HENANPA 008-2022 有毒中药饮片推荐目录及管理策略 2022-08-05