广东省食品从业人员.docx
《广东省食品从业人员.docx》由会员分享，可在线阅读，更多相关《广东省食品从业人员.docx（23页珍藏版）》请在冰豆网上搜索。
广东省食品从业人员
广东省食品从业人员
健康检查管理平台
接口规范文档
2017-11
改版记录
版本
发布日期
描述
作者
复审
批准
1.0
2017/11/24
建立该文档,初稿
变更记录
变更编号
日期
变更项
描述
基线版本
变更请求编号
广东省食品从业人员健康检查管理平台
接口规范文档
1概述
健康证管理平台按照省局关于体检机构现场巡查和体检业务实时监控的要求制定。
目的是实时获取体检机构的实时业务监控数据，保证服务业从业人员的体检信息的真实性。
主要实时监控如下：
健康证管理平台提供Webservice接口应用服务，供各接入系统访问调用。
在调用时，需按照本文档规定格式拼装参数，传入参数调用平台端webservice接口，接收webservice接口获取返回信息。
各接入系统将返回信息进行解析后供自身系统处理使用。
2适用范围
本文档主要用于描述Webservice接口的定义、调用说明。
文档可供接入健康证管理平台的各系统建设方、开发方阅读及使用。
3接口概述
接口概述
健康证管理平台作为服务端，以WebService方式为各个第三方系统等提供接口服务。
接口采用SOAP协议，请求方在请求时以base64加密入参，服务器解密处理，返回base64加密回参，请求端自行解密使用。
WebService接口统一入口方法为CallFun，通过method参数进行业务区分。
。
数据类型与格式
如无特殊说明，本文档中的部分数据均为以下格式：
●日期：
YYYY-MM-DD，即4位年，2位月份，2位日期。
数据类型记为DATE，长度为10。
●时间：
HH：
MM:
SS，即2位小时（24小时制），2为分钟，2为秒。
数据类型记为TIME，长度为6.
●日期时间：
YYYY-MM-DDHH：
MM:
SS。
数据类型记为DATETIME，长度为19.
●带毫秒日期时间：
YYYY-MM-DDHH：
MM：
SS：
FFF。
FFF为毫秒数。
数据类型记为DATETIME，长度为17。
●金额：
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两部分，具体格式如下：
应用Key
请求方法
接口方法版本
参数签名
请求时间
流水号
…
标签名
数据类型
中文名称
必填项
说明
appCode
String
请求应用的Code
是
接入方应用分配的应用Code
sessionId
String
会话ID或者Token
是
method
String
请求的方法
是
version
String
接口版本
否
sign
String
参数签名
否
reqTime
String
请求时间戳
是
reqTraceNo
String
流水号
是
3.1.2响应参数
响应参数为标准Xml字符串，顶层节点名称为Response，其下节点包括头部Header节点及响应数据Body两部分，具体格式如下：
结果值编码
结果描述
结果详细描述
…
标签名
数据类型
中文名称
必填项
说明
code
String
结果值编码
是
见字典（提示信息）
msg
String
结果消息
否
见字典（提示信息）
detail
String
结果详细描述
否
结果详细描述，错误时可以提供
respTime
DateTime
响应时间
是
格式:
yyyy-mm-ddHH：
mm：
ss
∙备注
当响应参数包括多个子项时，子项内容父节点为items，各子项内容节点为item。
...
接口访问地址
http:
//120.76.223.229:
1080/sayifpf/webService/FdaWsOutsideEntrance?
wsdl
4接口逻辑结构设计
微信预约平台接口架构
体检业务监控接口架构
5接口详细参数和格式
数据签名验证
5.1.1数字签名生成功能接口
webservice接口方法
CallFun
请求方法（method）
900100（见接口功能编号字典）
接口描述
数字签名生成接口
接口协议
webservice+xml
加密算法
MD5
5.1.1.1请求消息
标签名
必填
类型
说明
METHOD
是
String
接口业务类型（见接口功能编号字典）
ORGCODE
是
String
机构编码
USER
是
String
用户名
PASSWORD
是
String
用户接口密码，加密：
MD5
UUID
是
String
系统对接前，分配给机构的UUID，相当于身份唯一识别码
5.1.1.2返回消息
标签名
类型
说明
SIGNATURE
String
数字签名，该签名用于业务接口调用的认证码生成，数字签名具有时效性
微信端接口
5.1.2体检机构信息接口
webservice接口方法
CallFun
请求方法（method）
C00100（见接口功能编号字典）
接口描述
体检登记接口
接口协议
webservice+xml
加密算法
MD5+Base64
5.1.2.1请求信息
标签名
是否必填
类型
说明
METHOD
是
String
接口业务类型（见接口功能编号字典）
ORGCODE
是
String
机构编码
CHECKUUID
是
String
接口验证认证码，用于和服务器验证接口访问的合法性，该认证码依据数字签名以及参数值排序相应规则生成
SNAME
否
String
机构简称
NAME
否
String
机构名称
ADDRESS
否
String
地址
5.1.2.2返回消息
标签名
类型
说明
RESULT
String
接口调用结果：
SUCCESS,FAILED,ERROR
REMESSAGE
String
接口返回消息
ORGID
String
业务机构唯一码
CODE
String
机构编码
NAME
String
机构名称
SNAME
String
机构简称
PIC
String
图标
ORG_CODE
String
医疗机构代码
REGION
String
所在地区
ADDRESS
String
地址
HEAD
String
负责人
MOBILE
String
联系电话
LAT
String
纬度
LNG
String
经度
SUPERVISE
String
监管状态：
0-非监管，1-监管
MTIME
String
启用时间
RECOMMEND
String
推荐级别
WORK_SCHEDUL
String
E工作时间说明
SCORE
String
评价分数：
0~5
EVAL_SCORE
String
评价总分
EVAL_TIMES
String
评级次数
体检系统接口
5.1.3体检登记
webservice接口方法
CallFun
请求方法（method）
C00100（见接口功能编号字典）
接口描述
体检登记接口
接口协议
webservice+xml
加密算法
MD5+Base64
5.1.3.1请求信息
标签名
是否必填
类型
说明
METHOD
是
String
接口业务类型（见接口功能编号字典）
ORGCODE
是
String
机构编码
CHECKUUID
是
String
接口验证认证码，用于和服务器验证接口访问的合法性，该认证码依据数字签名以及参数值排序相应规则生成
ORG
是
String
体检机构
POSITION
是
String
体检点
VEHICLE
否
String
体检车辆
PNO
是
String
编码前缀
ORDER
是
String
预约单
ORDERTYPE
是
String
订购类型：
1-个人，2-团体，3-临时加号
NAME
是
String
姓名
IDCARD
是
String
身份证号码
GENDER
是
String
性别
AGE
是
String
年龄
ETHNIC
是
String
民族
HEAD
二者选一
String
身份证头像BASE64
CAPHEAD
String
身份证无法识别脸情况，身份证拍照BASE64
FACE
是
String
登记面部BASE64
MOBILE
否
String
联系电话
OPENID
否
String
微信号
TYPE
是
String
行业类别大类：
1：
食品
INDUSTRY
是
String
行业类别小类
DEGREE
否
String
文化程度
ORDERTIME
是
String
预约时间
ENROLLTIME
是
String
登记时间
ENROLLNO
是
String
登记号码，号码格式：
yyMMddA{1}B{3}（C{2}）?
，其中A为地点编号，B为序列号，C为复检编号，如果复检，尾号则加-1、-2等复检编号
5.1.3.2返回消息
标签名
类型
说明
RESULT
String
接口调用结果：
SUCCESS,FAILED,ERROR
REMESSAGE
String
接口返回消息
CERTID
String
体检登记唯一码
5.1.4体检结果体检明细接口
webservice接口方法
CallFun
请求方法（method）
C00200（见接口功能编号字典）
接口描述
体检登记接口
接口协议
webservice+xml
加密算法
MD5+Base64
5.1.4.1请求信息
标签名
是否必填
类型
说明
METHOD
是
String
接口业务类型（见接口功能编号字典）
ORGCODE
是
String
机构编码
CHECKUUID
是
String
接口验证认证码，用于和服务器验证接口访问的合法性，该认证码依据数字签名以及参数值排序相应规则生成
CERT
是
String
健康证信息ID
TYPE
是
String
体检类别：
0-初检，1-复检
ITEM
是
String
体检项目大类
CHECK_TIME
是
String
体检时间
CHECK_NAME
是
String
体检操作人
RESULT
是
String
结果：
Y-合格、N-不合格、X-未出结果
RESULT_TIME
是
String
结果时间
RESULT_NAME
是
String
结果录入人
VALID
是
String
结果有效性，Y-有效，N-无效，当复检结果录入时，把初检的结果设置为无效。
CHECKUP_TIME
是
String
体检时间
RESULT_TIME
是
String
结论时间
RESULT
是
String
检查结论：
Y-合格，N-未合格
RESULT_NOTE
是
String
检查结论说明
DOCTOR
是
String
结论医师
明细
CHECK
是
String
体检项目信息
ITEM
是
String
体检项目小类
RESULT
是
String
项目结果，Y-合格，N-不合格，S-可疑
DATA1
否
String
预留字段
DATA2
否
String
预留字段
DATA3
否
String
预留字段
DATA4
否
String
预留字段
MEMO
是
String
项目结果描述
5.1.4.2返回消息
标签名
类型
说明
RESULT
String
接口调用结果：
SUCCESS,FAILED,ERROR
REMESSAGE
String
接口返回消息
CHECKID
String
体检主表唯一ID
5.1.5健康证打印接口
webservice接口方法
CallFun
请求方法（method）
C00300（见接口功能编号字典）
接口描述
体检登记接口
接口协议
webservice+xml
加密算法
MD5+Base64
5.1.5.1请求信息
标签名
是否必填
类型
说明
METHOD
是
String
接口业务类型（见接口功能编号字典）
ORGCODE
是
String
机构编码
CHECKUUID
是
String
接口验证认证码，用于和服务器验证接口访问的合法性，该认证码依据数字签名以及参数值排序相应规则生成
CERT
是
String
健康证
USER
是
String
打印操作人
TIME
是
String
打印时间
NAME
是
String
健康证姓名
TEAM
是
String
所属团队
MOBILE
是
String
健康证联系方式
INDUSTRY
是
String
行业小类
5.1.5.2返回消息
标签名
类型
说明
RESULT
String
接口调用结果：
SUCCESS,FAILED,ERROR
REMESSAGE
String
接口返回消息
PRINTID
String
打印记录ID
5.1.6短信通知上传接口
webservice接口方法
CallFun
请求方法（method）
C00400（见接口功能编号字典）
接口描述
体检登记接口
接口协议
webservice+x
升级会员 