广东省食品从业人员.docx
- 文档编号:13183166
- 上传时间:2023-06-11
- 格式:DOCX
- 页数:55
- 大小:135.04KB
广东省食品从业人员.docx
《广东省食品从业人员.docx》由会员分享,可在线阅读,更多相关《广东省食品从业人员.docx(55页珍藏版)》请在冰点文库上搜索。
广东省食品从业人员
广东省食品从业人员
健康检查管理平台
接口规范文档V2.0
2018-1
改版记录
版本
发布日期
描述
批准
1.0
2017/11/24
建立该文档,初稿
1.5
2017/12/20
完善接口字段说明
2.0
2018/1/10
增加部分业务接口、查询接口、业务回退接口
变更记录
变更编号
日期
变更项
描述
基线版本
变更请求编号
广东省食品从业人员健康检查管理平台
接口规范文档
1概述
健康证管理平台按照省局关于体检机构现场巡查和体检业务实时监控的要求制定。
目的是实时获取体检机构的实时业务监控数据,保证服务业从业人员的体检信息的真实性。
主要实时监控如下:
健康证管理平台提供Webservice接口应用服务,供各接入系统访问调用。
在调用时,需按照本文档规定格式拼装参数,传入参数调用平台端webservice接口,接收webservice接口获取返回信息。
各接入系统将返回信息进行解析后供自身系统处理使用。
2适用范围
本文档主要用于描述Webservice接口的定义、调用说明。
文档可供接入健康证管理平台的各系统建设方、开发方阅读及使用。
3接口概述
接口概述
健康证管理平台作为服务端,以WebService方式为各个第三方系统等提供接口服务。
接口采用SOAP协议,请求方在请求时以base64加密入参,服务器解密处理,返回base64加密回参,请求端自行解密使用。
WebService接口统一入口方法为CallFun,通过method参数进行业务区分。
数据类型与格式
如无特殊说明,本文档中的部分数据均为以下格式:
●日期:
YYYY-MM-DD,即4位年,2位月份,2位日期。
数据类型记为DATE,长度为10,如:
2018-01-12。
●时间:
HH:
MM:
SS,即2位小时(24小时制),2为分钟,2为秒。
数据类型记为TIME,长度为6,如:
12:
01:
01。
●日期时间:
YYYY-MM-DDHH:
MM:
SS。
数据类型记为DATETIME,长度为19,如:
2018-01-1212:
01:
01。
●带毫秒日期时间:
YYYY-MM-DDHH:
MM:
SS:
FFF。
FFF为毫秒数。
数据类型记为DATETIME,长度为17,如:
2018-01-1212:
01:
01:
001。
●金额:
DDDDDDDD.DD,整数部分最多为8位,小数点1位,小数部分为2位,若小数部分为0,则小数点和小数部分可以省略。
计量单位为人民币元。
数据类型记为DECIMAL,最大长度为11。
●单价:
DDDDDDDD.DD,,整数部分最多为8位,小数点1位,小数部分最多为2位,若小数部分为0,则小数点和小数部分可以省略。
计量单位为人民币元。
数据类型记为DECIMAL,最大长度为11。
●数量:
DDDDDDDD.DD,8位整数,2为小数。
小数部分为0,小数点和小数部分可以省略,最大长度11位。
数据类型记为QUANTITY。
●其他数据请参照数据字典。
接口参数格式
3.1.1请求参数
请求参数为标准XML字符串,顶层节点名称为Request,其下节点包括头部Header及数据Body两部分,具体格式如下:
…
标签名
数据类型
中文名称
必填项
说明
appCode
varchar(64)
请求应用的Code
是
接入方应用分配的应用Code,开发者密钥
method
varchar(64)
请求的方法
是
接口功能列表
version
varchar(64)
接口版本
否
sign
varchar(64)
参数签名
是
加密:
MD5
reqTime
datetime
请求时间戳
是
格式:
yyyy-mm-ddHH:
mm:
ss如:
2018-01-1212:
01:
01
ORGCODE
varchar(64)
机构代码
是
3.1.2响应参数
响应参数为标准Xml字符串,顶层节点名称为Response,其下节点包括头部Header节点及响应数据Body两部分,具体格式如下:
结果值编码
…
标签名
数据类型
中文名称
必填项
说明
code
varchar(40)
结果值编码
是
提示信息
msg
varchar(40)
结果消息
否
提示信息
detail
varchar(255)
结果详细描述
否
结果详细描述,错误时可以提供
respTime
DateTime
响应时间
是
格式:
yyyy-mm-ddHH:
mm:
ss,如:
2018-01-1212:
01:
01
∙备注
当响应参数包括多个子项时,子项内容父节点为items,各子项内容节点为item。
...
接口访问地址
http:
//120.76.223.229:
1080/sayifpf/webService/FdaWsOutsideEntrance?
wsdl
4接口逻辑结构设计
体检业务监控接口架构
5接口功能列表
功能大类
功能编码
功能名称
公共类
900100
数字签名生成功能接口
业务登记类
C00300
体检登记接口
C00400
体检项目结果接口
C00500
健康证打印接口
C00600
短信通知上传接口
C00700
人脸比对数据接口
业务回退类
C00800
体检登记回退接口
C00900
体检结果体检明细回退接口
C01100
人脸比对数据回退接口
C01300
健康证打印回退接口
C01400
短信通知上传回退接口
业务查询类
C00100
查询体检机构信息接口
C01500
查询体检登记接口
C01600
查询体检项目接口
C01700
查询体检项目明细接口
C01800
查询人脸比对数据接口
C02000
查询健康证打印接口
C02100
查询短信通知接口
6接口详细参数和格式
公共接口部分
6.1.1数字签名生成功能接口
webservice接口方法
CallFun
请求方法(method)
900100(见接口功能列表)
接口描述
数字签名生成接口
接口协议
webservice+xml
加密算法
MD5
6.1.1.1请求消息
标签名
必填
类型
说明
METHOD
是
varchar(64)
接口业务类型(见接口功能列表)
ORGCODE
是
varchar(64)
机构编码
USER
是
varchar(64)
用户名
PASSWORD
是
varchar(64)
用户接口密码,加密:
MD5,默认:
123456
UUID
是
varchar(64)
系统对接前,分配给机构的UUID,相当于身份唯一识别码,开发者密钥
6.1.1.2返回消息
标签名
类型
说明
SIGNATURE
String
数字签名,该签名用于业务接口调用的认证码生成,数字签名具有时效性
业务登记接口部分
6.1.2体检登记接口
webservice接口方法
CallFun
请求方法(method)
C00300(见接口功能列表)
接口描述
体检登记接口
接口协议
webservice+xml
加密算法
MD5+Base64
6.1.2.1请求信息
标签名
是否必填
类型
说明
VEHICLE
否
varchar(40)
体检车辆车牌号码
ORDER
否
varchar(40)
预约单编号
ORDERTYPE
是
varchar
(1)
订购类型:
1-个人,2-团体,3-临时加号
NAME
是
varchar(64)
姓名
IDCARD
是
varchar(20)
身份证号码
GENDER
是
varchar
(1)
性别:
1-男,2-女
AGE
是
int(11)
年龄
ETHNIC
是
varchar
(2)
民族(参考字典7.3)
HEAD
二者不能同时为空
varchar(40)
身份证头像BASE64
CAPHEAD
varchar(40)
身份证无法识别脸情况,身份证拍照BASE64
FACE
是
varchar(40)
登记面部BASE64
MOBILE
否
varchar(20)
联系电话
OPENID
否
varchar(40)
微信号
TYPE
是
varchar
(1)
行业类别大类(参考字典7.1)
INDUSTRY
是
varchar(64)
行业类别小类(参考字典7.2)
DEGREE
否
varchar(40)
文化程度
ORDERTIME
是
datetime
预约时间,格式yyyy-MM-ddHH:
mm:
ss,如:
2018-01-1212:
01:
01
ENROLLTIME
是
datetime
登记时间,格式yyyy-MM-ddHH:
mm:
ss,如:
2018-01-1212:
01:
01
ENROLLNO
是
varchar(20)
登记号码,体检机构自定义的唯一体检登记序列号,一个从业人员在此机构一次体检的标志。
6.1.2.2返回消息
标签名
类型
说明
RESULT
varchar(40)
接口调用结果:
SUCCESS,FAILED,ERROR
REMESSAGE
varchar(255)
接口返回消息
CERTID
varchar(40)
体检登记唯一码(接口系统保存的本次体检登记的唯一标识码,业务回退时用这个编码进行回退)
6.1.3体检项目结果接口
webservice接口方法
CallFun
请求方法(method)
C00400(见接口功能列表)
接口描述
体检项目结果接口
接口协议
webservice+xml
加密算法
MD5+Base64
6.1.3.1请求信息
标签名
是否必填
类型
说明
CERTID
是
varchar(40)
体检登记ID(对应体检登记接口返回的CERTID)
TYPE
是
varchar
(1)
体检类别:
0-初检,1-复检
ITEM
是
varchar
(2)
体检项目大类:
01-血液,02-粪便,03-胸透,04-体征
CHECK_TIME
是
datetime
体检时间,格式yyyy-MM-ddHH:
mm:
ss,如:
2018-01-1212:
01:
01
CHECK_NAME
是
varchar(64)
体检操作人
RESULT
是
varchar
(1)
结果:
Y-合格、N-不合格
RESULT_TIME
是
datetime
结果时间,格式yyyy-MM-ddHH:
mm:
ss,如:
2018-01-1212:
01:
01
RESULT_NAME
是
varchar(64)
结果录入人
VALID
是
varchar
(1)
结果有效性,Y-有效,N-无效,当复检结果录入时,把初检的结果设置为无效。
CHECKUP_TIME
是
datetime
体检时间,格式yyyy-MM-ddHH:
mm:
ss,如:
2018-01-1212:
01:
01
RESULT_TIME_CERT
是
datetime
结论时间,格式yyyy-MM-ddHH:
mm:
ss,如:
2018-01-1212:
01:
01
RESULT_CERT
是
varchar
(1)
检查结论:
Y-合格,N-未合格
RESULT_NOTE
是
varchar(512)
检查结论说明
DOCTOR
是
varchar(40)
结论医师
ENROLLNO
是
varchar(20)
体检登记号码,体检机构自定义的唯一体检登记序列号,一个从业人员在此机构一次体检的标志。
明细
ITEM
是
varchar(4)
体检项目小类:
0101-谷丙转氨酶,
0102-甲型肝炎抗体测定
0103-戊型肝炎抗体测定
0201-痢疾杆菌
0202-伤寒、副伤寒
0301-胸透DR
0401-心
0402-肝
0403-肺
0404-脾
0405-皮肤
RESULT
是
varchar
(1)
项目结果,Y-合格,N-不合格,S-可疑
DATA1
否
varchar(40)
预留字段
DATA2
否
varchar(40)
预留字段
DATA3
否
varchar(40)
预留字段
DATA4
否
varchar(40)
预留字段
MEMO
是
varchar(512)
项目结果描述
6.1.3.2返回消息
标签名
类型
说明
RESULT
varchar(40)
接口调用结果:
SUCCESS,FAILED,ERROR
REMESSAGE
varchar(255)
接口返回消息
CHECKID
varchar(40)
体检结果ID(接口系统保存的体检结果唯一编号。
务必保存,验血人脸比对、胸透人脸比对、以及体检结果明细回退等接口有作为入参)
6.1.4健康证打印接口
webservice接口方法
CallFun
请求方法(method)
C00500(见接口功能列表)
接口描述
健康证打印接口
接口协议
webservice+xml
加密算法
MD5+Base64
6.1.4.1请求信息
标签名
是否必填
类型
说明
CERTID
是
varchar(40)
体检登记信息ID(对应体检登记接口返回CERTID)
ENROLLNO
是
varchar(20)
登记号码,体检机构自定义的唯一体检登记序列号,一个从业人员在此机构一次体检的标志。
USER
是
varchar(40)
打印操作人
TIME
是
datetime
打印时间,格式yyyy-MM-ddHH:
mm:
ss,如:
2018-01-1212:
01:
01
NAME
是
varchar(40)
健康证姓名
TEAM
否
varchar(40)
所属单位
MOBILE
是
varchar(40)
健康证联系方式
INDUSTRY
是
varchar(40)
行业类别小类(参考字典7.2)
6.1.4.2返回消息
标签名
类型
说明
RESULT
varchar(40)
接口调用结果:
SUCCESS,FAILED,ERROR
REMESSAGE
varchar(255)
接口返回消息
PRINTID
varchar(40)
打印记录ID
6.1.5短信通知上传接口
webservice接口方法
CallFun
请求方法(method)
C00600(见接口功能列表)
接口描述
短信通知上传接口
接口协议
webservice+xml
加密算法
MD5+Base64
6.1.5.1请求信息
标签名
是否必填
类型
说明
CERTID
是
varchar(40)
体检登记信息ID(对应体检登记接口返回CERTID)
MOBILE
是
varchar(11)
手机号码
CONTENT
是
varchar(512)
发送内容
TIME
是
datetime
发送时间,格式yyyy-MM-ddHH:
mm:
ss,如:
2018-01-1212:
01:
01
6.1.5.2返回消息
标签名
类型
说明
RESULT
varchar(40)
接口调用结果:
SUCCESS,FAILED,ERROR
REMESSAGE
varchar(255)
接口返回消息
SMSID
varchar(40)
短信唯一码
6.1.6人脸比对数据接口
webservice接口方法
CallFun
请求方法(method)
C00700(见接口功能列表)
接口描述
人脸比对分析接口
接口协议
webservice+xml
加密算法
MD5+Base64
6.1.6.1请求信息
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 广东省 食品 从业人员
![提示](https://static.bingdoc.com/images/bang_tan.gif)