系统交互接口规范

系统交互接口规范系统交互接口规范 2020.10.1 第1页修改记录版本号版本号修改编号修改编号更改时间更改时间更改的更改的图表和章节号图表和章节号更改简要描述更改简要描述更改人更改人批准批准人人第2页目录 1.接口交互设计. 4 1.1.接口简述. 4 1.2.设备结果查询接口 . 4 1.2.1.应用场景 . 4 1.2.2.流程交互 . 4 1.2.3.流程交互说明 . 4 1.2.4.接口定义 . 4 1.2.5.中间库表定义 . 5 2.规则及注意事项. 6 3.附录. 6 3.1.示例. 6 3.1.1.XML 格式示例. 6 第3页 1.1.接口交互设计接口交互设计 1.1.1.1.接口简述接口简述按接口所要部署的系统划分，交互接口主要分以下几类： A 类：此类接口在 XXX 系统中实现及部署，供 XXX 系统模块调用； B 类：此类接口在 XXX 系统模块中实现及部署，供 XXX 系统调用； 1.2.1.2.设备结果查询接口设备结果查询接口 1.2.1.1.2.1.应用场景应用场景 XXX 系统模块查询设备的结果信息。 1.2.2.1.2.2.流程交互流程交互 1.2.3.1.2.3.流程交互说明流程交互说明 (1)XXX 系统模块将需查询分拣结果的设备信息，写入中间库。 (2)写入中间库后，XXX 系统模块调用 XXX 系统的 WS 接口，通知 XXX 系统。 (3)XXX 系统接收到通知后，从中间表读取设备信息。 (4)XXX 系统根据读取到的设备信息，查询分拣结果信息，并将结果信息回写如中间库。 (5)XXX 系统将结果写入中间库后，通知 XX 管理模块。 (6)XXX 系统读取中间库信息并进行后续操作。 1.2.4.1.2.4.接口定义接口定义 1.2.4.1.1.2.4.1.查询请求接口查询请求接口接口说明接口说明接口类型接口类型接口方式接口方式方法名称方法名称 XXX 系统模块向 XXX 发起查询请求。 A 类接口，部署在 XXX 系统 WebService + +中间表第4页数据频度数据频度输入参数中文名称输入参数中文名称工单批次号请求时间校验码返回数据中文名称返回数据中文名称返回码信息描述一个月调用一次，实时交互输入参数英文名称输入参数英文名称返回数据英文名返回数据英文名数据格式数据格式参数格式参数格式含义含义含义含义 1.2.4.2.1.2.4.2.查询结果通知接口查询结果通知接口接口说明接口说明接口类型接口类型接口方式接口方式方法名称方法名称数据频度数据频度输入参数中文名称输入参数中文名称工单批次号请求时间返回数据中文名称返回数据中文名称返回码信息描述 XXX 通知 XX 管理模块查询结果。实时输入参数英文名称输入参数英文名称返回数据英文名返回数据英文名数据格式数据格式参数格式参数格式含义含义含义含义 1.2.5.1.2.5.中间库表定义中间库表定义 1.2.5.1.1.2.5.1.设备信息设备信息(MID_REPICK_METER_REQ)(MID_REPICK_METER_REQ) 中文名中文名英文名英文名数据类型数据类型必填必填写入写入含义含义主键联单编号第5页中文名中文名英文名英文名数据类型数据类型必填必填写入写入含义含义 1.2.5.2.1.2.5.2.设备结果信息设备结果信息 (MID_REPICK_METER_RES)(MID_REPICK_METER_RES) 中文名中文名英文名英文名数据类型数据类型必填必填写入写入含义含义 2.2.规则及注意事项规则及注意事项 1、支持单个或多个设备数据并行上送。 2、WebService 接口支持 50 次/秒并发调用。 3.3.附录附录 3.1.3.1.示例示例 3.1.1.3.1.1.XMLXML 格式示例格式示例 3.1.1.1.3.1.1.1.入参入参 XMLXML 格式格式第6页 12345678 01 3.1.1.2.3.1.1.2.出参只有返回状态的出参只有返回状态的 XMLXML 格式格式 1 XXXX 3.1.1.3.3.1.1.3.出参既有返回状态又有数据内容的出参既有返回状态又有数据内容的 XMLXML 格式格式 1 XXXX 3340121009801007024933 3340101020900009098296 3340121009801007024933 3340101020900009098296 3.1.1.4.3.1.1.4.出参出参 XMLXML 嵌套子集格式嵌套子集格式第7页 1 1234556 2016-01-01 08:01:01 821083061 0 F01006 02 第8页