退役军人档案对接

main
CL 2 years ago
parent 341c397375
commit 4b7cee9d9c

@ -0,0 +1,570 @@
使用手册
天津市天深科技股份有限公司
文档编号
OA收发公文数据对接- HTTP接口使用手册
密级级别:[外部公开]
生效时间: 2019年9月1日
保密期:无
天津市天深科技股份有限公司 版权所有
目 录
目 录 2
1. 开发前必读 3
1.1 概述 3
1.2 错误码说明 3
1.3 接口调用顺序 4
2. 接口说明 5
2.1 上传初始化 5
2.2 上传数据包 6
2.3 开始处理 8
3. 数据包格式说明 10
3.1 参考资料 10
3.2 数据包结构说明 10
3.3 移交说明及目录XML内容描述 11
3.4 归档文件元数据.xml内容描述 12
开发前必读
概述
本文档主要提供给OA办公系统数据交互的接口使用手册具体包括公文接入过程、常见问题等内容。
本接口使用java语言编写。
注意每次提交待归档条目数据包均采用zip压缩包格式
错误码说明
接口被调用后,会返回错误码和具体错误信息。
错误码
含义说明
0
接口调用成功,并正常返回
其他
系统异常、接口报错、数据参数无效等
接口调用顺序
调用方调用接口顺序
{host} 项目地址 例: 127.0.0.1
{port} 项目端口 例: 8080
{address} 项目名称(可以为空)
1. 上传初始化http://{host}:{port}/oa /InitUpload.do
2. 上传数据包http://{host}:{port}/oa /UploadData.do
3开始处理http://{host}:{port}/oa /UploadFile.do
接口说明
上传初始化
oo 调用方
OA等第三方系统
oo 接口地址
http://{host}:{port}/oa/InitUpload.do
oo 提交方式
POST
oo 编码要求
utf-8
oo Content-Type
multipart/form-data
oo 输入参数
属性名称
属性描述
类型
必须
备注
filesize
文件大小
Int
为整数(单位字节)
filename
文件名称
String
为需要上传的文件名称(包含扩展名)。
oo 入参举例如下:
{
"filesize": 512,
"filename": "数据包.zip"
}
oo 返回类型
application/json
oo 返回编码
utf-8
oo 返回参数
属性名称
属性描述
类型
必须
备注
code
错误码
Integer
0表示成功其它详见错误码说明
errMsg
错误消息
String
错误信息
oo 返回值样例如下:
{
"code": 0,
"errMsg":"错误信息"
}
上传数据包
oo 调用方
OA等第三方系统
oo 接口地址
http://{host}:{port}/oa/UploadData.do
oo 提交方式
POST
oo 编码要求
utf-8
oo Content-Type
multipart/form-data
oo 输入参数
属性名称
属性描述
类型
必须
备注
fileName
为所上传文件的名称
String
fileSize
为上传的数据块长度
Int
为整数(单位字节)
file
为所上传的数据包
file
oo 入参举例如下:
{
"fileName": "数据包.zip",
"fileSize": 512,
"file": "原件src"
}
oo 返回类型
application/json
oo 返回编码
utf-8
oo 返回参数
属性名称
属性描述
类型
必须
备注
code
错误码
Integer
0表示成功其它详见错误码说明
errMsg
错误消息
String
错误信息
oo 返回值样例如下:
{
"code": 0,
"errMsg":"错误信息"
}
开始处理
oo 调用方
OA等第三方系统
本方法为完成上传后,待所有数据块传输完毕后调用本方法
oo 接口地址
http://{host}:{port}/oa/UploadFile.do
oo 提交方式
POST
oo 编码要求
utf-8
oo Content-Type
multipart/form-data
oo 输入参数
属性名称
属性描述
类型
必须
备注
FileName
为UploadData方法传输完毕的文件名称
String
文件名称 带后缀
OffSoftName
为数据导入软件的软件名称
String
(如:今易、先行、用友等)。默认值:今易。
OffSoftVer
数据导入软件的版本号
String
V1.0、V1.1、V2.0等。默认值V1.0
Dept
为归档部门编号
String
OA中与档案同步的部门编码(部门ID) 具体现场双方对接后决定
doctype
表示需要归档的记录是收文还是发文
String
取值范围0表示收文1表示发文2 表示督办(如有其他类型可商讨)3.协同
Strategy
策略(对gdwx.xml中的稿本快的数量和类型进行不同的策略)
String
1.必须有正文和处理单 2.必须有正文
oo 入参举例如下:
{
"FileName": "数据包.zip",
"OffSoftName": "今易",
"OffSoftVer": "V1.0",
"Dept": "1100",
"doctype": "0",
"Strategy": "1"
}
oo 返回类型
application/json
oo 返回编码
utf-8
oo 返回参数
属性名称
属性描述
类型
必须
备注
code
错误码
Integer
0表示成功其它详见错误码说明
errMsg
错误消息
String
错误信息
oo 返回值样例如下:
{
"code": 0,
"errMsg":"错误信息"
}
数据包格式说明
参考资料
DB12T 692-2016天津市文书类电子文件元数据规范[内部].pdf
DB12T 693-2016天津市文书类电子文件数据存储结构规范[内部].pdf
数据包结构说明
1. 数据包为zip压缩包 名称为{UUID}.zip 保证数据包名称唯一
2. 移交说明及目录xml、归档文件元数据.xml如果国产服务器遇到中文名称乱码问题可改为
移交说明及目录.xmlyjsm.xml
归档文件元数据.xml(gdwj.xml)
3. zip包中包含两部分内容
a. 移交说明及目录.xmlyjsm.xml
b. 收发文归档文件夹(有几条公文就有几个文件夹)
4. 收发文归档文件夹内内容说明
a. 归档文件元数据.xml(gdwj.xml)
b. 板式文件ofd/pdf
c. 每一个公文文件夹中都要有一个 gdwj.xml
移交说明及目录XML内容描述
1. 说明及目录.xml中档号应与公文的文件夹名保持一致
2. 其他内容按格式填写即可
3. 多条同时归档 公文信息均写到同一个目录描述中
目录结构
<root>
<电子文件移交说明及目录描述>
<目录描述>
<档号>5001-2020-00000054-5</档号>
<题名>天津市档案局公文送审签发单</题名>
<文件编号>无202024号</文件编号>
<责任者>111</责任者>
<日期>20200908</日期>
<页数>1</页数>
<档号>5001-2020-00000054-6</档号>
<题名>天津市档案局公文送审签发单</题名>
<文件编号>无202024号</文件编号>
<责任者>111</责任者>
<日期>20200908</日期>
<页数>1</页数>
<档号>5001-2020-00000054-7</档号>
<题名>天津市档案局公文送审签发单</题名>
<文件编号>无202024号</文件编号>
<责任者>111</责任者>
<日期>20200908</日期>
<页数>1</页数>
</目录描述>
<电子文件移交说明/>
</电子文件移交说明及目录描述>
</root>
归档文件元数据.xml内容描述
元数据包含4部分内容
文件实体
文件实体包含
档号、题名、并列题名、类别、主题词或关键字、人名、摘要、文件编号、责任者、保管期限、机构或问题、控制标识、日期、文种、主送、抄送、密级、保密期限、页数、附注、脱机载体编号、稿本块、流程追踪
文件实体必填字段请参考
DB12T 692-2016天津市文书类电子文件元数据规范[内部].pdf
附录B 文书类电子文件元数据表 形成办理
下面列出档案系统的必填项有哪些 如缺少不予接收
字段名
约束性
数据格式
档号
必填
UUID 保证唯一性
题名
必填
并列题名
条件选
解释或从属于题名和另一题名
类别
条件选
主题词或关键字
条件选
在标引和检索上用以表达电子文件主题的规范化的词或词组,取自电子文件题名或正文
人名
条件选
文件内容中涉及的具有检索意义的人物姓名
摘要
条件选
对电子文件核心内容的简短陈述。
文件编号
条件选
202024号
责任者
必填
正文上盖章的 单位
保管期限
条件选
格式 10年、30年、永久
机构或问题
必填
对电子文件进行实体分类整理时按部门或问题分类的结果(部门)
控制标识
必填
根据用户需求定制
日期
必填
8位数字 例: 20200901
文种
必填
必填 收文 发文 (如果有更多类型可沟通)
主送
条件选
文件的主要受理者,一般为文件内容规定任务的主要执行者。 公文主要受文 单位或个人
抄送
条件选
除主送者以外需要执行或知晓文件的其他受文者。 公文主要受文 单位或个人
密级
必填
值域 (公开、内部、国内、秘密、机密、绝密)
保密期限
条件选
值域 10年 30年 永久
页数
条件选
正整数
附注
条件选
电子文件和元数据中需要解释和补充说明的事项
脱机载体编号
条件选
电子文件脱机存储载体排列顺序的一组代码
稿本块
必填
根据http://{host}:{port}/oa/UploadFile.do 的 Strategy 参数来走
流程追踪
条件选
上述所有参数如有疑问均可去 <DB12T 692-2016天津市文书类电子文件元数据规范[内部].pdf> 文件中查询
其中 稿本块、流程追踪有其子级内容
稿本块
一个公文会有多个原件、有几个原件就有几个稿本
注意事项
A. 原件类型分为三种 1.正文 2. 处理单 3.附件
B. 文件标识符应与数据包中原件名称保持一致 ,否则不予以接收
C. 正文和处理单 OA系统每一个公文必须传给档案系统否则不予以接收
元数据中名称
写入内容为
描述
备注
稿本类型
原件类型
1.正文 2. 处理单 3.附件
其中 正文必须有没有不接收(其他类型可根据不同情况商讨)
稿本文件
原件中文名称
原件实际中文名称
文件标识符
原件实体名称
使用原件的uuid为原件实体名称
此处文件标识符为uuid是为了防止在国产服务器下编码问题造成文件名中文乱码
<稿本块>
<稿本>
<稿本类型>正文</稿本类型>
<稿本文件>132b16b3b2d748d78b37e10011ebd7ab</稿本文件>
<文件标识符>5e29ac3d8fad4d1698456af503eaaa3a</文件标识符>
</稿本>
<稿本>
<稿本类型>附件</稿本类型>
<稿本文件>中软sw运维周报0813</稿本文件>
<文件标识符>a6858ceeb2ee4b389c40e60a2fe1eb08</文件标识符>
</稿本>
<稿本>
<稿本类型>处理单</稿本类型>
<稿本文件>处理单</稿本文件>
<文件标识符>86109a38bc3643a9a3141331703c3b6f</文件标识符>
</稿本>
</稿本块>
流程追踪
流程追踪为OA实际办理的流程日志、此处具体情况有每一种OA系统根据实际情况填写
<流程跟踪>
<环节名称>承办人拟稿</环节名称>
<办理人>王颖</办理人>
<办理部门>档案综合处</办理部门>
<接收时间>2020-09-08 15:25</接收时间>
<当前状态>已完成</当前状态>
<完成时间>2020-09-08 15:26</完成时间>
</流程跟踪>
机构人员实体块
机构人员实体块具体填写内容也在现场与OA系统沟通后确定
<机构人员实体块>
<机构人员实体>
<机构人员标识符>8679360f5f954ffb893591e7f6038e5e</机构人员标识符>
<机构名称/>
<人员名称></人员名称>
</机构人员实体>
<机构人员实体>
<机构人员标识符>8679360f5f954ffb893591e7f6038e5e</机构人员标识符>
<机构名称/>
<人员名称></人员名称>
</机构人员实体>
<机构人员实体>
<机构人员标识符>8679360f5f954ffb893591e7f6038e5e</机构人员标识符>
<机构名称/>
<人员名称></人员名称>
</机构人员实体>
</机构人员实体块>
业务实体块
业务实体块具体填写内容也在现场与OA系统沟通后确定
<业务实体块>
<业务实体>
<机构人员标识符>1</机构人员标识符>
<业务行为></业务行为>
<行为时间>Tue Sep 08 15:27:37 CST 2020</行为时间>
<文件标识符>5e29ac3d8fad4d1698456af503eaaa3a</文件标识符>
</业务实体>
<业务实体>
<机构人员标识符>1</机构人员标识符>
<业务行为></业务行为>
<行为时间>Tue Sep 08 15:26:33 CST 2020</行为时间>
<文件标识符>a6858ceeb2ee4b389c40e60a2fe1eb08</文件标识符>
</业务实体>
<业务实体>
<机构人员标识符>1</机构人员标识符>
<业务行为></业务行为>
<行为时间>Tue Sep 08 15:27:00 CST 2020</行为时间>
<文件标识符>86109a38bc3643a9a3141331703c3b6f</文件标识符>
</业务实体>
</业务实体块>
实体关系块
实体关系快为当前条目与原件的管理关系描述
<实体关系块>
<实体关系>
<实体标识>132afd2219224fbcaa200c85672eaecf</实体标识>
<文件标识符>5e29ac3d8fad4d1698456af503eaaa3a</文件标识符>
</实体关系>
<实体关系>
<实体标识>132afd2219224fbcaa200c85672eaecf</实体标识>
<文件标识符>a6858ceeb2ee4b389c40e60a2fe1eb08</文件标识符>
</实体关系>
<实体关系>
<实体标识>132afd2219224fbcaa200c85672eaecf</实体标识>
<文件标识符>86109a38bc3643a9a3141331703c3b6f</文件标识符>
</实体关系>
</实体关系块>
Loading…
Cancel
Save