广东省食品从业人员

广东省食品从业人员健康检查管理平台9Version: 1.0.0接口规范Date: 2017-11-24Page: 24 of 24广东省食品从业人员健康检查管理平台接口规范文档2017-11改版记录版本发布日期描述作者复审批准1.02017/11/24建立该文档,初稿变更记录变更编号日期变更项描述基线版本变更请求编号 目录1概述42适用范围43接口概述43.1接口概述43.2数据类型与格式53.3接口参数格式53.3.1请求参数53.3.2响应参数63.4接口访问地址84接口逻辑结构设计84.1微信预约平台接口架构84.2体检业务监控接口架构85接口详细参数和格式95.1数据签名验证95.1.1数字签名生成功能接口95.2微信端接口105.2.1体检机构信息接口115.3体检系统接口145.3.1体检登记145.3.2体检结果体检明细接口175.3.3健康证打印接口205.3.4短信通知上传接口22广东省食品从业人员健康检查管理平台接口规范文档 1 概述健康证管理平台按照省局关于体检机构现场巡查和体检业务实时监控的要求制定。目的是实时获取体检机构的实时业务监控数据，保证服务业从业人员的体检信息的真实性。主要实时监控如下：健康证管理平台提供Webservice接口应用服务，供各接入系统访问调用。在调用时，需按照本文档规定格式拼装参数，传入参数调用平台端webservice接口，接收webservice接口获取返回信息。各接入系统将返回信息进行解析后供自身系统处理使用。2 适用范围本文档主要用于描述Webservice接口的定义、调用说明。文档可供接入健康证管理平台的各系统建设方、开发方阅读及使用。3 接口概述3.1 接口概述健康证管理平台作为服务端，以WebService方式为各个第三方系统等提供接口服务。接口采用SOAP协议，请求方在请求时以base64加密入参，服务器解密处理，返回base64加密回参，请求端自行解密使用。WebService接口统一入口方法为CallFun，通过method参数进行业务区分。3.2 数据类型与格式如无特殊说明，本文档中的部分数据均为以下格式：l 日期： YYYY-MM-DD，即4位年，2位月份，2位日期。数据类型记为DATE，长度为10。l 时间：HH：MM:SS，即2位小时（24小时制），2为分钟，2为秒。数据类型记为TIME，长度为6.l 日期时间：YYYY-MM-DD HH：MM:SS。数据类型记为DATETIME，长度为19.l 带毫秒日期时间：YYYY-MM-DD HH：MM：SS：FFF。FFF为毫秒数。数据类型记为DATETIME，长度为17。l 金额：DDDDDDDD.DD，整数部分最多为8位，小数点1位，小数部分为2位，若小数部分为0，则小数点和小数部分可以省略。计量单位为人民币元。数据类型记为DECIMAL，最大长度为11。l 单价：DDDDDDDD.DD,，整数部分最多为8位，小数点1位，小数部分最多为2位，若小数部分为0，则小数点和小数部分可以省略。计量单位为人民币元。数据类型记为DECIMAL，最大长度为11。l 数量：DDDDDDDD.DD，8位整数，2为小数。小数部分为0，小数点和小数部分可以省略，最大长度11位。数据类型记为QUANTITY。l 其他数据请参照数据字典。3.3 接口参数格式3.3.1 请求参数请求参数为标准XML字符串，顶层节点名称为Request，其下节点包括头部Header及数据Body两部分，具体格式如下： 应用Key 请求方法 接口方法版本 参数签名 请求时间 流水号 标签名数据类型中文名称必填项说明appCodeString请求应用的Code是接入方应用分配的应用CodesessionIdString会话ID或者Token是methodString请求的方法是versionString接口版本否signString参数签名否reqTimeString请求时间戳是reqTraceNoString流水号是3.3.2 响应参数响应参数为标准Xml字符串，顶层节点名称为Response，其下节点包括头部Header节点及响应数据Body两部分，具体格式如下： 结果值编码 结果描述 结果详细描述 标签名数据类型中文名称必填项说明codeString结果值编码是见字典（提示信息）msgString结果消息否见字典（提示信息）detailString结果详细描述否结果详细描述，错误时可以提供respTimeDateTime响应时间是格式:yyyy-mm-dd HH：mm：ss 备注当响应参数包括多个子项时，子项内容父节点为items，各子项内容节点为item。 头部公共响应参数 . 3.4 接口访问地址29:1080/sayifpf/webService/FdaWsOutsideEntrance?wsdl 4 接口逻辑结构设计4.1 微信预约平台接口架构4.2 体检业务监控接口架构5 接口详细参数和格式5.1 数据签名验证5.1.1 数字签名生成功能接口webservice接口方法CallFun请求方法（method）（见接口功能编号字典）接口描述数字签名生成接口接口协议webservice+xml加密算法MD 请求消息 头部公共请求参数 标签名必填类型说明METHOD是String接口业务类型（见接口功能编号字典）ORGCODE是String机构编码USER是String用户名PASSWORD是String用户接口密码，加密：MD5UUID是String系统对接前，分配给机构的UUID，相当于身份唯一识别码 返回消息 头部公共响应参数 标签名类型说明SIGNATUREString数字签名，该签名用于业务接口调用的认证码生成，数字签名具有时效性5.2 微信端接口5.2.1 体检机构信息接口webservice接口方法CallFun请求方法（method）C00100（见接口功能编号字典）接口描述体检登记接口接口协议webservice+xml加密算法MD5+Base6 请求信息头部公共请求参数 标签名是否必填类型说明METHOD是String接口业务类型（见接口功能编号字典）ORGCODE是String机构编码CHECKUUID是String接口验证认证码，用于和服务器验证接口访问的合法性，该认证码依据数字签名以及参数值排序相应规则生成SNAME否String机构简称NAME否String机构名称ADDRESS否String地址 返回消息 头部公共响应参数 标签名类型说明RESULTString接口调用结果：SUCCESS,FAILED,ERRORREMESSAGEString接口返回消息ORGIDString业务机构唯一码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_SCHEDULStringE工作时间说明 SCORE String评价分数：05 EVAL_SCORE String评价总分 EVAL_TIMES String评级次数 5.3 体检系统接口5.3.1 体检登记webservice接口方法CallFun请求方法（method）C00100（见接口功能编号字典）接口描述体检登记接口接口协议webservice+xml加密算法MD5+Base6 请求信息头部公共请求参数 标签名是否必填类型说明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登记面部BASE 64 MOBILE 否String联系电话 OPENID 否String微信号 TYPE 是String行业类别大类：1：食品 INDUSTRY 是String行业类别小类 DEGREE 否String文化程度 ORDERTIME 是String预约时间 ENROLLTIME 是String登记时间 ENROLLNO 是String登记号码，号码格式：yyMMddA1B3(C2)?，其中A为地点编号，B为序列号，C为复检编号，如果复检，尾号则加-1、-2等复检编号 返回消息 头部公共响应参数 标签名类型说明RESULTString接口调用结果：SUCCESS,FAILED,ERRORREMESSAGEString接口返回消息CERTIDString体检登记唯一码5.3.2 体检结果体检明细接口webservice接口方法CallFun请求方法（method）C00200（见接口功能编号字典）接口描述体检登记接口接口协议webservice+xml加密算法MD5+Base6 请求信息头部公共请求参数 标签名是否必填类型说明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项目结果描述 返回消息 头部公共响应参数 标签名类型说明RESULTString接口调用结果：SUCCESS,FAILED,ERRORREMESSAGEString接口返回消息CHECKIDString体检主表唯一ID5.3.3 健康证打印接口webservice接口方法CallFun请求方法（method）C00300（见接口功能编号字典）接口描述体检登记接口接口协议webservice+xml加密算法MD5+Base6 请求信息头部公共请求参数 标签名是否必填类型说明METHOD是String接口业务类型（见接口功能编号字典）ORGCODE是String机构编码CHECKUUID是String接口验证认证码，用于和服务器验证接口访问的合法性，该认证码依据数字签名以及参数值排序相应规则生成CERT 是String健康证 USER 是String打印操作人 TIME 是String打印时间 NAME 是String健康证姓名 TEAM 是String所属团队 MOBILE 是String健康证联系方式 INDUSTRY是String行业小类 返回消息 头部公共响应参数 标签名类型说明RESULTString接口调用结果：SUCCESS,FAILED,ERRORREMESSAGEString接口返回消息PRINTIDString打印记录ID5.3.4 短信通知上传接口webservice接口方法CallFun请求方法（method）C00400（见接口功能编号字典）接口描述体检登记接口接口协议webservice+xml加密算法MD5+Base6 请求信息头部公共请求参数 标签名是否必填类型说明METHOD是