终端智能仓储语音拣货系统《接口设计》docx

1、终端一体化项目之终端智能仓储语音拣货系统接口设计 接口对接需求说明书终端一体化项目之终端智能仓储语音拣货系统接口设计文件状态： 草稿 正式发布 正在修改当前版本：1.2作 者：秦志超完成日期：2013-05-20浙江航天电子产业有限公司版 本 历 史版本/状态作者参与者起止日期备注1.0秦志超2013-05-201. 创建此文档1.1秦志超陈强、余忠舜2013-05-222. 修改拣货产品信息，统一字段.确认文档接口设计1.2秦志超陈强2013-06-051. 在拣货产品信息中添加长，宽，高字段定义。(该长宽高为单个该产品的长宽高参数，不需统计总计)目录1 WTMS定义41.1 WTMS对外接

2、口描述41.2 接口命名规范41.3 接口消息实现41.4 UTMS与WCS交互流程61.5 字段类型说明61.5.1 WTMS消息约束：61.5.2 WTMS消息头定义：71.5.3 WTMS消息体定义:71.6 消息接口定义7接口定义相关对象9pickup_info_schema(捡货目标)91.7 消息格式:101.7.1 UTMS拣货指令消息格式: (UTMS >> WCS)101.7.2 UTMS拣货指令消息返回消息格式: (WCS>>UTMS)111.7.3 UTMS拣货情况反馈消息格式: (WCS >> UTMS)111.7.4 UTMS拣货情

3、况反馈消息返回消息格式: (UTMS>>WCS)121 WTMS定义所有请求和响应消息均应采用WTMS格式的消息封装，包含 WTMS消息头(Header)和WTMS消息体（Body）二部分。对任何技术实现的调用者而言，发出的调用请求消息均须带有以上二部分内容，消息头和消息体的消息结构中引用的类型均来自本规范中的定义。但在WTMS包体中，如果按照规范定义某一参数为可选，则WTMS消息中可不包含标识该参数的元素。返回的WTMS消息结构同请求消息。采用 http+xml技术进行传输通信。1.1 WTMS对外接口描述编号接口描述接口协议请求方响应方IF_1指令发送接口HTTP+XMLUTM

4、SWCSIF_2拣货情况反馈接口HTTP+XMLWCSUTMS1.2 接口命名规范 接口名称采用单词首字母大写，其他字母小写的方式。缩略语中的字母都大写。消息内容定义中，基本数据类型的字段命名规范采用单词首字母大写，单词间没有连接符的方式。1.3 接口消息实现WTMS接口格式采用基于HTTP+XML协议，以Web服务的方式进行相互之间的通信，所有消息均采用请求和响应配对的方式，即：一个xxxReq对应有一个xxxResp。在接口实现方式方面，包括异步交互通信方式和同步交互通信方式两种。异步通信方式：请求方向响应方发送报文后，接收方校验报文格式和内容正确后，立刻向请求方发送接收结果报文，异步对报

5、文的内容进行相应的处理。如下图所示：如果对于服务处理结果需要返回给服务使用者，则需要原服务提供者作为服务的使用者重新发起一个新的反馈处理结果请求服务，用于反馈服务处理的结果。同步通信方式：请求方向响应方发送报文后，接收方校验保温格式和内容正确后，不立即向请求方发送报文，而是先根据报文的内容进行相应的处理，处理完毕后，将处理结果返回至发送方。如下图所示：1.4 UTMS与WCS交互流程1. UTMS向WCS下达拣货指令，WCS接收到指令后，立即反馈给UTMS接收结果，并开始进行拣货操作流程；2. WCS语音协助拣货操作完成后，补充已拣货数量将拣货情况反馈给UTMS，UTMS接收到反馈情况后，立即

6、反馈给WCS接收的结果。1.5 字段类型说明integer：十进制的整数型。unsigned integer：十进制的无符号整数型。string：由char组成的字符串1.5.1 WTMS消息约束：l 使用标准的XML定义l 标签为<WTMS></WTMS>1.5.2 WTMS消息头定义：l 标签为<WTMS-Header></WTMS-Header>l 具体字段定义：字段名类型长度说明TransactionIDstring20请求和应答消息都必须，格式如下：14位的时间串+6位的SequenceVersionstring10请求和应答消息都必须

7、，该接口消息的版本号，本次的接口消息的版本为“1.0”MessageNamestring50消息名称,和<WTMS-Body>中的具体消息一致MessageFlagstring10消息类型(0表示测试消息，1表示正式消息)SendAddressstring20发送方代号(UTMS或WCS)RecvAddressstring20接收方代号(同上互逆)1.5.3 WTMS消息体定义: l 标签为<WTMS-Body></WTMS-Body>1.6 消息接口定义 捡货指令消息（PickUpReq）.1 功能描述此接口用于UTMS向WCS

8、下达捡货命令。消息名消息类型消息方向PickUpReqRequestUTMSàWCSPickUpRespResponseWCS àUTMS.2 接口内容描述PickUpReq消息字段描述：字段名重要性类型长度说明PickUpOrgID必须string10拣货组织UserID必须string10拣货人IDUserName必须string10拣货人名称PickUpID必须string20拣货单IDPickUpCode必须String20捡货单号PickUpInfo必须pickup_info_schema1.n (集合)捡货目标清单PickUpResp消息字段描述：

9、字段名重要性类型长度说明ResultID必须Int1接收结果（1:成功；2:失败；）ResultString20结果信息 捡货情况反馈消息（PickUpResultReq）.1 功能描述此接口用于WCS捡货完毕后，向UTMS反馈捡货情况。说明： 消息数据为在原UTMS拣货指令消息基础上添加已拣货数量字段即可。消息名消息类型消息方向PickUpResultReqRequestWCSàUTMSPickUpResultRespResponseUTMSàWCS.2 接口内容描述PickUpResultReq消息字段描述：字段名重要性类型长度

10、说明PickUpOrgID必须string10拣货组织UserID必须string10拣货人IDUserName必须string10拣货人名称PickUpID必须string20拣货单IDPickUpCode必须String20捡货单号PickUpInfo必须pickup_info_schema1.n (集合)捡货目标清单PickUpResultResp消息字段描述：字段名重要性类型长度说明ResultID必须Int1接收结果（1:成功；2:失败；）ResultString20结果信息接口定义相关对象pickup_info_schema(捡货目标)字段名称字段类型长度字段描述DepotIDst

11、ring10仓位ID DepotCode string20仓位编号 ProductIDstring10产品编号ProductNameString50产品名称 (HTC-820T-冰川银)PickNumberint应拣货数量FulfilNumberint已拣货数量(UTMS首次发送指令时为0,WCS反馈消息时填充该值)ProductLengthint长(对应单个ProductName产品属性参数，不统计总和)ProductWidthint宽(同上)ProductHeightint高(同上)1.7 消息格式:1.7.1 UTMS拣货指令消息格式: (UTMS >> WCS)<?x

12、ml version="1.0" encoding="UTF-8"?><WTMS><WTMS-Header><TransactionID>20130517135750000000</TransactionID><Version>1.0</Version><MessageName>PickUpReq</MessageName><MessageFlag>1</MessageFlag><SendAddress>UTMS<

13、;/SendAddress><RecvAddress>WCS</RecvAddress></WTMS-Header><WTMS-Body><PickUpReq> <PickUpOrgID>12</PickUpOrgID> <UserID>7895</UserID> <UserName>张三</UserName><PickID>2194</PickID><PickCode>BC_ZD-GZ_13000564</Pick

14、Code><PickUpInfo><DepotId>1342</DepotId><DepotCode>GZ-A-01-02-01</DepotCode><ProductID>2123</ProductID><ProductName>华为-G520-白</ProductName><PickNumber>23</PickNumber><FulfilNumber>0</FulfilNumber><ProductLength>18

15、</ProductLength><ProductWidth>9</ProductWidth><ProductHeight>4</ProductHeight></PickUpInfo></PickUpReq></WTMS-Body></WTMS>1.7.2 UTMS拣货指令消息返回消息格式: (WCS>>UTMS)<?xml version="1.0" encoding="utf-8"?><WTMS><WTM

16、S-Header><TransactionID>20130517135750000000</TransactionID><Version>1.0</Version><MessageName>PickUpResp</MessageName><MessageFlag>1</MessageFlag><SendAddress>WCS</SendAddress><RecvAddress>UTMS</RecvAddress></WTMS-Header&

17、gt;<WTMS-Body><PickUpResp><ResultID>1</ResultID><Result>BC_ZD-GZ_13000564指令发送成功</Result></PickUpResp></WTMS-Body></WTMS>1.7.3 UTMS拣货情况反馈消息格式: (WCS >> UTMS)<?xml version="1.0" encoding="UTF-8"?><WTMS><WTMS-

18、Header><TransactionID>20130517135750000001</TransactionID><Version>1.0</Version><MessageName>PickUpResultReq</MessageName><MessageFlag>1</MessageFlag><SendAddress>WCS</SendAddress><RecvAddress>UTMS</RecvAddress></WTMS-Head

19、er><WTMS-Body><PickUpResultReq> <PickUpOrgID>12</PickUpOrgID> <UserID>7895</UserID> <UserName>张三</UserName><PickID>2194</PickID><PickCode>BC_ZD-GZ_13000564</PickCode><PickUpInfo><DepotId>1342</DepotId><De

20、potCode>GZ-A-01-02-01</DepotCode><ProductID>2123</ProductID><ProductName>华为-G520-白</ ProductName><PickNumber>23</PickNumber><FulfilNumber>20</FulfilNumber><ProductLength>18</ProductLength><ProductWidth>9</ProductWidth><ProductHeight>4</ProductHeight></PickUpInfo></PickUpResultReq></WTMS-Body></WTMS>1.7.4 UTMS拣货情况