电子文档系统接口说明WebService接口.docx
- 文档编号:25347474
- 上传时间:2023-06-07
- 格式:DOCX
- 页数:19
- 大小:21.03KB
电子文档系统接口说明WebService接口.docx
《电子文档系统接口说明WebService接口.docx》由会员分享,可在线阅读,更多相关《电子文档系统接口说明WebService接口.docx(19页珍藏版)》请在冰豆网上搜索。
电子文档系统接口说明WebService接口
XX系统
WebService接口
(V1.00)
2016年8月
版本修订历史记录格式:
附:
版本修订历史记录
版本
日期
修改内容
作者
1.0
2016-08-11
1.1
2017-01-01
1.2
2017-05-17
1.调用接口顺序
1.1.新增档案及文档
1)调用“同步档案”接口
2)调用“档案资料文件上传”
1.2.修改档案及文档
1)查询后台管理系统做新增档案及文档时,“同步档案”入参及出参返回的wjxxid值
2)调用“同步档案”接口(需要传全部材料列表)
3)调用“档案资料文件上传”接口(需要传全部材料列表)
1.3.查询档案信息及调阅文档信息图像
1)根据查询条件调用“查阅档案”接口
2)根据“查阅档案”接口返回的wjxxid,调用“调阅档案”接口查询得到wjxxid相应的材料列表信息,其中包括文件所在路径wjlj
2.同步档案
2.1.简要描述
关联关系编号
关联关系名称
提供方
数据量
热点
时效性
R_DA_001
文件上传
档案管理系统
单笔
是
实时
WSDL地址
XX.XX.XX.XX:
7001/dzda/services/wsService?
wsdl(测试环境)
业务规则
外围系统进行同步档案,同步档案可分为4种情况:
●同步档案信息,操作为添加;(只同步档案信息的需要外围系统提供接口查询材料信息)
●同步档案信息,操作为更新;(只同步档案信息的需要外围系统提供接口查询材料信息)
●同步档案信息和材料信息,操作为添加;
●同步档案信息和材料信息,操作为更新,会覆盖以前的材料列表,因此需要传全部材料列表。
报文结构
节点名
描述
备注
数据来源
Header
wsse:
Username
须校验的用户名
固定值
电子档案系统提供
wsse:
Password
须校验的密码
固定值
电子档案系统提供
Body
syncWjxx
arg0
接口服务名
接口入参
详细入参如下:
2.2.请求报文
详细入参:
节点名
描述
是否必填
数据来源
arg0
wjxxid
档案id
同步档案非必填,但是必有字段。
修改档案和作废档案时候为必填
修改档案时填写,填写为此档案的档案ID
Czrdm
操作人代码
必填
查询人员代码表(DM_GY_SWRY)人员代码(SWRY_DM)
Czrjgdm
操作人机关代码
必填
根据人员代码查询人员身份代码表(DM_QX_SWRYSF)身份机构(SFSWJG_DM)
nsrsbh
人识别号
必填
后台管理系统审核任务中查询预申请信息的查询结果列表字段:
人识别号/个人身份证号码。
nsrmc
人名称
必填
后台管理系统审核任务中查询预申请信息的查询结果列表字段:
人名称
sxid
事项代码
必填
功能-事项-材料对照表
sxmc
事项名称
必填
功能-事项-材料对照表
gljgdm
人主管机构代码
必填
通过登记序号查询人主管机关信息表(DJ_NSRZGSWJGXX)中主管所(科、分局)代码字段(ZGSWSKFJ_DM)
slrq
业务受理日期
必填
后台管理系统审核任务中查询预申请信息的查询结果列表字段:
业务办理时间
daztdm
档案状态代码
作废档案时必填。
作废:
0
同步中:
S0(或不传值)
完成同步:
20
ys
文件总页数
必填
读取PDF总页数(如一笔业务有10份材料,有5份材料上传电子文件共15页,那么ys为15)
bgqxdm
档案保管期限代码
必填
需填写时根据事项及局方确认
ywxtdm
业务系统代码
必填
电子档案档案系统提供
ywlsh
业务流水号
必填
受理的业务流水号/后台管理系统业务流水号,未定,由局方确定
sjly
数据来源
必填
l代表链接(只同步基本信息到省局档案系统,材料信息通过接口查询本地档案系统。
)
F代表需要有材料信息(可以没有文件,材料信息必须要有)
Update
操作是否为更新
必填
同步档案时为False,修改为true
Wbxt
外部系统字段
必填
固定值:
wbxt
用于校验传值sxid是否有效
clList
clxxid
材料信息id
需要同步材料时,必填
新增档案时不用填
clmc
材料名称
必填
档案材料列表显示项
clid
材料
必填
sqfs
收取方式
必填
档案材料列表显示项
ys
文件页数
视情况而定
档案材料列表显示项
(如果有pdf文件需要上传,必填)
wjlj
文件路径
视情况而定
档案材料列表显示项
(如果有pdf文件需要上传,必填)
2.3.响应报文
报文结构
节点名
描述
备注
Body
code
操作代码
0:
操作失败,1:
操作成功,2:
拒绝操作
content
返回内容
操作成功时才有,存放保存后的档案信息id
message
错误信息
操作不成功的原因
3.档案资料文件上传
3.1.简要描述
关联关系编号
关联关系名称
提供方
数据量
热点
时效性
R_DA_006
文件上传
档案管理系统
单笔
是
实时
WSDL地址
业务规则
外围系统进行同步档案,同步档案可分为4种情况:
●上传档案资料文件接口。
3.2.请求报文
报文结构
节点名
描述
备注
数据来源
Header
wsse:
Username
须校验的用户名
固定值
电子档案系统提供
wsse:
Password
须校验的密码
固定值
电子档案系统提供
Body
syncWjxxForUpload
接口服务名
接口入参
详细入参如下:
详细入参:
节点名
描述
是否必填
arg0
wjxxid
档案id
必填
添加档案时,来源于同步档案接口中的返回报文content
Czrdm
操作人代码
必填
校验人员
czrjgdm
操作人机关代码
选填
不填时,会根据操作人代码在电子档案系统获取人员机关代码
nsrsbh
人识别号
必填
后台管理系统审核任务中查询预申请信息的查询结果列表字段:
人识别号/个人身份证号码。
nsrmc
人名称
必填
后台管理系统审核任务中查询预申请信息的查询结果列表字段:
人名称
sxid
事项代码
必填
功能-事项-材料对照表(详见SVN)
sxmc
事项名称
必填
功能-事项-材料对照表(详见SVN)
gljgdm
人主管机构代码
必填
通过登记序号查询人主管机关信息表(DJ_NSRZGSWJGXX)中主管所(科、分局)代码字段(ZGSWSKFJ_DM)
slrq
业务受理日期
必填
后台管理系统审核任务中查询预申请信息的查询结果列表字段:
业务办理时间
daztdm
档案状态代码
作废档案时必填。
作废:
0
同步中:
S0(或不传值)
完成同步:
20
ys
文件总页数
必填
读取PDF总页数(如一笔业务有10份材料,有5份材料上传电子文件共15页,那么ys为15)
bgqxdm
档案保管期限代码
必填
需填写时根据事项及局方确认
ywxtdm
业务系统代码
必填
电子档案档案系统提供
ywlsh
业务流水号
受理的业务流水号/后台管理系统业务流水号,未定,由局方确定
sjly
数据来源
数据来源为Sjly.LINK时,不需要同步材料,当”F”同步材料和相应影像件文件流
F代表接口创建并上传文件。
l(小写L)代表是链接
Update
操作是否为更新
必填项
true为上传材料,false不做任何操作。
ClxxList
clmc
材料名称
必填
操作为添加时:
对应功能-事项-材料对照表
clid
材料
必填(及数据库已有的档案数据的材料id进行比对,一致才上传文件,否则返回clid串)
操作为添加时:
对应功能-事项-材料对照表
ys
pdf文件页数
必填
来源于后台管理系统上传的PDF的页数
上传文件名称
必须,且必须包含文件后缀
来源于PDF所在后台管理系统服务器的文件名称包含后缀
上传文件流
进行base64位加密
来源于后台管理系统对PDF进行64位加密后的文件流代码
3.3.响应报文
报文结构
节点名
描述
备注
Body
code
操作代码
0:
操作失败,1:
操作成功,2:
拒绝操作
content
返回内容
操作成功时才有,存放保存后的档案信息id
message
错误信息
操作不成功的原因
4.查询档案
4.1.简要描述
关联关系编号
关联关系名称
提供方
数据量
热点
时效性
R_DA_002
查询档案
档案管理系统
单笔/多笔
是
实时
WSDL地址
host/contextPath/services/wsService?
wsdl
业务规则
外围系统对档案进行查询,通过输入查询条件,根据条件查询列出相应的档案列表。
4.2.请求报文
报文结构
节点名
描述
备注
数据来源
Header
wsse:
Username
须校验的用户名
固定值
电子档案系统提供
wsse:
Password
须校验的密码
固定值
电子档案系统提供
Body
queryWjxxs
接口服务名
分页查询档案。
还有一个对象接口为queryWjxxsString
arg0
接口入参
内容为xml,详细如下
R入参报文结构如下:
报文结构
节点名
描述
备注
数据来源
arg0
index
页号
自填
size
分页大小
最大100(1页为一个wjxx)
自填
nsrsbh
人识别号
自填
sxid
事项代码
保障平台规程代码
自填
ssjg
数据所属机构
自填
zgjg
人主管机构
自填
from
创建(受理)时间起
包括(>=)
自填
to
创建(受理)时间止
不包括(<)
自填
czrdm
操作人代码
必填
自填
czrjgdm
操作人机关代码
必填
自填
查询条件截图:
4.3.响应报文
报文结构
节点名
描述
备注
Body
code
操作代码
0:
操作失败,1:
操作成功,2:
拒绝操作
message
错误信息
操作不成功的原因
total
总记录数
pageIndex
当前页数
pageNum
总页数
pageSize
每页记录数
wjxxs
当前页的具体档案列表
详细档案信息节点如下
wjxx节点结构如下:
节点名
描述
备注
wjxx
wjxxid
档案id
nsrsbh
人识别号
nsrmc
人名称
sxid
事项代码
sxmc
事项名称
gljgdm
人主管机构代码
slrq
业务受理日期
daztdm
档案状态代码
ys
文件页数
bgqxdm
档案保管期限代码
ywxtdm
业务系统代码
ywlsh
业务流水号
5.调阅档案
5.1.简要描述
关联关系编号
关联关系名称
提供方
数据量
热点
时效性
R_DA_003
调阅档案
档案管理系统
单笔
是
实时
WSDL地址
host/contextPath/services/wsService?
wsdl
业务规则
外围系统进行调阅档案,通过查询条件wjxxid/jtxm,将查询到的档案条目信息以及材料信息返回给外围系统。
5.2.请求报文
报文结构
节点名
描述
备注
数据来源
Header
wsse:
Username
须校验的用户名
固定值test
电子档案系统提供
wsse:
Password
须校验的密码
固定值test
电子档案系统提供
Body
queryWjxxDetail
接口服务名
查询档案详细信息。
还有一个对象接口为queryWjxxDetailString
arg0
czrdm
操作人代码
必填
自填
czrjgdm
操作人机构代码
必填
自填
wjxxid
档案id
必填
由查询档案返回参数提供
5.3.响应报文
报文结构
节点名
描述
备注
Body
code
操作代码
0:
操作失败,1:
操作成功
wjxx
返回内容
操作成功时才有,存放查询的档案详细信息
message
错误信息
操作不成功的原因
wjxx节点结构如下:
节点名
描述
备注
wjxx
wjxxid
档案id
nsrsbh
人识别号
nsrmc
人名称
sxid
事项代码
sxmc
事项名称
gljgdm
人主管机构代码
slrq
业务受理日期
daztdm
档案状态代码
ys
文件总页数
一笔10份材料每份5页,总页数为50页
bgqxdm
档案保管期限代码
ywxtdm
业务系统代码
ywlsh
业务流水号
clList
材料信息
详细材料信息节点如下
wscl节点结构如下:
节点名
描述
备注
wscl
clxxid
材料信息id
clmc
材料名称
clid
材料id
sqfs
材料收取方式
wjlj
文件查看路径
ys
文件页数
6.数据字典
6.1.Daztdm
6.2.Bgqxdm
bgqxdm档案的保管期限代码,5,10,永久三个选择
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 电子 文档 系统 接口 说明 WebService