終端智能倉儲語音揀貨系統(tǒng)《接口設計》docx

1、終端一體化項目之終端智能倉儲語音揀貨系統(tǒng)接口設計 接口對接需求說明書終端一體化項目之終端智能倉儲語音揀貨系統(tǒng)接口設計文件狀態(tài)： 草稿 正式發(fā)布 正在修改當前版本：1.2作 者：秦志超完成日期：2013-05-20浙江航天電子產(chǎn)業(yè)有限公司版 本 歷 史版本/狀態(tài)作者參與者起止日期備注1.0秦志超2013-05-201. 創(chuàng)建此文檔1.1秦志超陳強、余忠舜2013-05-222. 修改揀貨產(chǎn)品信息，統(tǒng)一字段.確認文檔接口設計1.2秦志超陳強2013-06-051. 在揀貨產(chǎn)品信息中添加長，寬，高字段定義。(該長寬高為單個該產(chǎn)品的長寬高參數(shù)，不需統(tǒng)計總計)目錄1 WTMS定義41.1 WTMS對外接

2、口描述41.2 接口命名規(guī)范41.3 接口消息實現(xiàn)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）二部分。對任何技術實現(xiàn)的調(diào)用者而言，發(fā)出的調(diào)用請求消息均須帶有以上二部分內(nèi)容，消息頭和消息體的消息結構中引用的類型均來自本規(guī)范中的定義。但在WTMS包體中，如果按照規(guī)范定義某一參數(shù)為可選，則WTMS消息中可不包含標識該參數(shù)的元素。返回的WTMS消息結構同請求消息。采用 http+xml技術進行傳輸通信。1.1 WTMS對外接口描述編號接口描述接口協(xié)議請求方響應方IF_1指令發(fā)送接口HTTP+XMLUTM

4、SWCSIF_2揀貨情況反饋接口HTTP+XMLWCSUTMS1.2 接口命名規(guī)范 接口名稱采用單詞首字母大寫，其他字母小寫的方式?？s略語中的字母都大寫。消息內(nèi)容定義中，基本數(shù)據(jù)類型的字段命名規(guī)范采用單詞首字母大寫，單詞間沒有連接符的方式。1.3 接口消息實現(xiàn)WTMS接口格式采用基于HTTP+XML協(xié)議，以Web服務的方式進行相互之間的通信，所有消息均采用請求和響應配對的方式，即：一個xxxReq對應有一個xxxResp。在接口實現(xiàn)方式方面，包括異步交互通信方式和同步交互通信方式兩種。異步通信方式：請求方向響應方發(fā)送報文后，接收方校驗報文格式和內(nèi)容正確后，立刻向請求方發(fā)送接收結果報文，異步對報

5、文的內(nèi)容進行相應的處理。如下圖所示：如果對于服務處理結果需要返回給服務使用者，則需要原服務提供者作為服務的使用者重新發(fā)起一個新的反饋處理結果請求服務，用于反饋服務處理的結果。同步通信方式：請求方向響應方發(fā)送報文后，接收方校驗保溫格式和內(nèi)容正確后，不立即向請求方發(fā)送報文，而是先根據(jù)報文的內(nèi)容進行相應的處理，處理完畢后，將處理結果返回至發(fā)送方。如下圖所示：1.4 UTMS與WCS交互流程1. UTMS向WCS下達揀貨指令，WCS接收到指令后，立即反饋給UTMS接收結果，并開始進行揀貨操作流程；2. WCS語音協(xié)助揀貨操作完成后，補充已揀貨數(shù)量將揀貨情況反饋給UTMS，UTMS接收到反饋情況后，立即

6、反饋給WCS接收的結果。1.5 字段類型說明integer：十進制的整數(shù)型。unsigned integer：十進制的無符號整數(shù)型。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發(fā)送方代號(UTMS或WCS)RecvAddressstring20接收方代號(同上互逆)1.5.3 WTMS消息體定義: l 標簽為<WTMS-Body></WTMS-Body>1.6 消息接口定義 撿貨指令消息（PickUpReq）.1 功能描述此接口用于UTMS向WCS

8、下達撿貨命令。消息名消息類型消息方向PickUpReqRequestUTMSàWCSPickUpRespResponseWCS àUTMS.2 接口內(nèi)容描述PickUpReq消息字段描述：字段名重要性類型長度說明PickUpOrgID必須string10揀貨組織UserID必須string10揀貨人IDUserName必須string10揀貨人名稱PickUpID必須string20揀貨單IDPickUpCode必須String20撿貨單號PickUpInfo必須pickup_info_schema1.n (集合)撿貨目標清單PickUpResp消息字段描述：

9、字段名重要性類型長度說明ResultID必須Int1接收結果（1:成功；2:失?。唬㏑esultString20結果信息 撿貨情況反饋消息（PickUpResultReq）.1 功能描述此接口用于WCS撿貨完畢后，向UTMS反饋撿貨情況。說明： 消息數(shù)據(jù)為在原UTMS揀貨指令消息基礎上添加已揀貨數(shù)量字段即可。消息名消息類型消息方向PickUpResultReqRequestWCSàUTMSPickUpResultRespResponseUTMSàWCS.2 接口內(nèi)容描述PickUpResultReq消息字段描述：字段名重要性類型長度

10、說明PickUpOrgID必須string10揀貨組織UserID必須string10揀貨人IDUserName必須string10揀貨人名稱PickUpID必須string20揀貨單IDPickUpCode必須String20撿貨單號PickUpInfo必須pickup_info_schema1.n (集合)撿貨目標清單PickUpResultResp消息字段描述：字段名重要性類型長度說明ResultID必須Int1接收結果（1:成功；2:失?。唬㏑esultString20結果信息接口定義相關對象pickup_info_schema(撿貨目標)字段名稱字段類型長度字段描述DepotIDst

11、ring10倉位ID DepotCode string20倉位編號 ProductIDstring10產(chǎn)品編號ProductNameString50產(chǎn)品名稱 (HTC-820T-冰川銀)PickNumberint應揀貨數(shù)量FulfilNumberint已揀貨數(shù)量(UTMS首次發(fā)送指令時為0,WCS反饋消息時填充該值)ProductLengthint長(對應單個ProductName產(chǎn)品屬性參數(shù)，不統(tǒng)計總和)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指令發(fā)送成功</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揀貨情況