單一窗口物流貨物全流程監(jiān)控接口說明v1.0(非正式)_第1頁
單一窗口物流貨物全流程監(jiān)控接口說明v1.0(非正式)_第2頁
單一窗口物流貨物全流程監(jiān)控接口說明v1.0(非正式)_第3頁
單一窗口物流貨物全流程監(jiān)控接口說明v1.0(非正式)_第4頁
單一窗口物流貨物全流程監(jiān)控接口說明v1.0(非正式)_第5頁
已閱讀5頁，還剩22頁未讀， 繼續(xù)免費閱讀

下載本文檔

版權(quán)說明：本文檔由用戶提供并上傳，收益歸屬內(nèi)容提供方，若內(nèi)容存在侵權(quán)，請進行舉報或認領

文檔簡介

廣州國際貿(mào)易“單一窗口” 單一窗口物流貨物全流程監(jiān)控接口說明單一窗口物流貨物全流程監(jiān)控接口說明v1.02016年9月

修訂歷史日期版本描述作者2016-09-251.0初稿杜建偉

目錄1. 概述 41.1. 編寫目的 41.2. 背景 41.3. 閱讀對象 41.4. 定義 42. 采集對接范圍定義 52.1. 對接單位代碼定義 52.2. 采集單位與環(huán)節(jié)關系定義 52.2.1. 進口環(huán)節(jié) 52.2.2. 出口環(huán)節(jié) 53. 數(shù)據(jù)接口協(xié)議說明 53.1. 報文文件交換方式 53.1.1. 接口功能描述 53.1.2. 報文格式要求 53.1.3. 狀態(tài)編碼說明 63.1.4. 報文類型定義說明 63.1.5. 報文基本結(jié)構(gòu)及說明 63.1.6. 報文文件命名要求 73.2. WebService協(xié)議通訊方式 74. 數(shù)據(jù)接口說明 74.1. 接受委托 74.1.1. 功能描述 74.1.2. 報文格式內(nèi)容說明 74.1.3. ftp接口規(guī)范 94.1.4. Webservice接口規(guī)范 134.2. 換單完成 154.2.1. 功能描述 154.2.2. 報文格式內(nèi)容說明 154.2.3. ftp接口規(guī)范 164.2.4. Webservice接口規(guī)范 194.3. 已換取設備交接單 214.3.1. 功能描述 214.3.2. 報文格式內(nèi)容說明 224.3.3. ftp接口規(guī)范 224.3.4. Webservice接口規(guī)范 26概述編寫目的本文檔圍繞單一窗口建立物流通關貨物監(jiān)控平臺，建設中需要企業(yè)協(xié)助提供某一環(huán)節(jié)相應的物流貨物數(shù)據(jù)，本文即是在此情況下編寫，用于指導企業(yè)具體提供哪些數(shù)據(jù)。單一窗口接口分為三種，一種是直接通過FTP的方式，一種是通過調(diào)用對方提供的WebService的方式。這兩種方式都需要先按指定的格式生成的內(nèi)容，對于報文交換的方式，則需要生成物理文件，而對于WebService的方式，則不需要生成物理文件，不存在報文命名的問題。以下是對于生成報文內(nèi)容以及物理文件的要求進行說明。背景水運進出貨物通關物流追蹤系統(tǒng)主要通過采集進出口各環(huán)節(jié)狀態(tài)的的數(shù)據(jù)，形成一個涵蓋進出口企業(yè)、報關報檢代理、船代、碼頭、理貨公司、運輸企業(yè)等與進出口貿(mào)易相關的企業(yè)以及海關、檢驗檢疫、邊檢、海事、港務、口岸辦等口岸管理單位及其它政府部門的狀態(tài)大數(shù)據(jù)，并通過網(wǎng)頁或移動終端的展示方式為企業(yè)提供對貨物通關物流狀態(tài)進行實時透明的全流程跟蹤服務，同時為口岸管理部門及相關政府部門提供全方位的統(tǒng)計分析服務，

通過對通關物流環(huán)節(jié)的大數(shù)據(jù)智能分析，精準定位耗時長、效率低的通關環(huán)節(jié)，為壓縮通關時間，促進通關效率提供更有效的決策支持。閱讀對象本文檔的閱讀對象為系統(tǒng)設計、開發(fā)人員、軟件測試人員、技術(shù)評審人員、技術(shù)管理人員等。定義數(shù)據(jù)接口：本文檔涉及的數(shù)據(jù)接口涵蓋基于Ftp文件形式的數(shù)據(jù)報文接口，以及基于http協(xié)議的Web接口。采集對接范圍定義對接單位代碼定義采集范圍發(fā)送人/接收人名稱代碼備注對接企業(yè)企業(yè)XXXX此部分代碼由電子口岸提供給相關企業(yè)采集單位與環(huán)節(jié)關系定義進口環(huán)節(jié)單位進出口標識涉及環(huán)節(jié)備注船代進口接受委托在貨主委托船代換單完成進出口企業(yè)或報關報檢代理到船公司/船代換取提貨單（大船提單換小船提單，直航也需換單）已換取設備交接單報關代理向船代船公司已換取設備交接單報關報檢代理進口接受委托在貨主委托報關報檢代理出口環(huán)節(jié)單位進出口標識涉及環(huán)節(jié)備注船代出口接受委托在貨主委托船代報關報檢代理出口接受委托在貨主委托報關報檢代理數(shù)據(jù)接口協(xié)議說明報文文件交換方式接口功能描述實現(xiàn)企業(yè)物流貨物進口接受委托，換單，已換取設備交接單等環(huán)節(jié)數(shù)據(jù)接入到“廣州國際貿(mào)易“單一窗口”平臺”。單一窗口平臺接收數(shù)據(jù)并入庫。報文格式要求采用XML作為報文格式，字符編碼統(tǒng)一采用UTF-8格式：encoding="UTF-8"報文應以<?xmlversion="1.0"encoding="UTF-8"?>開始。狀態(tài)編碼說明用于提供給企業(yè)標示某一個環(huán)節(jié)的具體狀態(tài)標志，狀態(tài)編碼共有5位，第一位代表進出口1進口，2出口；中間兩位代表具體的狀態(tài)環(huán)節(jié)；后面兩位代表此環(huán)節(jié)明細狀態(tài)從01開始最大99，例如：10101代表是進口流程中接受委托環(huán)節(jié)第一個已接收狀態(tài)。本次涉及企業(yè)提供的相關編碼如下：狀態(tài)編碼狀態(tài)描述10101接受委托10501換單完成11301已換取設備交接單報文類型定義說明報文類型編碼待電子口岸提供：xxxxx報文基本結(jié)構(gòu)及說明報文頭節(jié)點名稱節(jié)點說明節(jié)點內(nèi)容說明<Message><Head><MessageID>報文唯一編號組成規(guī)則：[MessageType]_[SenderId]_[SendTime]+[4位隨機數(shù)字]

注意：此處[SendTime]的格式為：yyyyMMddhhmmss<MessageType>報文類型參照本文中“報文類型定義”一節(jié)。<Sender>發(fā)送方代碼參照報文接收人代碼定義<Receiver>發(fā)送方代碼參照報文接收人代碼定義<SendTime>發(fā)送時間格式：yyyyMMddhhmmss<Version>報文版本號報文格式版本號，初始固定為“1.0”<Body>業(yè)務節(jié)點1

業(yè)務節(jié)點2

…報文文件命名要求文件名稱規(guī)則為：[MessageType]_[Sender]_[SendTime]+[3位隨機數(shù)字].xml其中[MessageType]名稱參考報文類型定義，[Sender]代表發(fā)送方代碼,[SendTime]代表發(fā)送時間，精確到秒，采用yyyyMMddhhmmss例如：SWSHIP002_GZSW_20150611103131002.xmlWebService協(xié)議通訊方式采用restfullwebservice進行實現(xiàn)數(shù)據(jù)接口說明接受委托狀態(tài)編碼為10101功能描述用于接收企業(yè)物流貨物進口提交資料環(huán)節(jié)數(shù)據(jù)接口的服務。報文格式內(nèi)容說明節(jié)點節(jié)點名稱字段長度描述備注NODE_CODE狀態(tài)編碼VARCHAR2(5)SHIP_CODE船編VARCHAR2(50)SHIP_NAME船名VARCHAR2(100)E_VOYAGE航次VARCHAR2(20)DOCK_CODE碼頭代碼VARCHAR2(8)DOCK_NAME碼頭名稱VARCHAR2(50)BL_NO_N提單列表信息VARCHAR2(50)提單號1~9999個SHIP_PROXY_CODE船代代碼VARCHAR2(50)SHIP_PROXY_NAME船代代碼名稱VARCHAR2(100)IE_ENTERPRISE_CODE進出口企業(yè)代碼VARCHAR2(20)IE_ENTERPRISE_NAME進出口企業(yè)代碼名稱VARCHAR2(100)OPERATOR經(jīng)辦人VARCHAR2(50)OPER_TIME時間DATE格式：2016-06-2311:41:05CONTACTS_MOBILE聯(lián)系電話VARCHAR2(20)CUS_COMPANY報關報檢公司代碼VARCHAR2(50)CUS_COMPANY_NAME報關報檢公司名稱VARCHAR2(100)IE_TYPE進出口標識CHAR(2)I:進口;E:出口REMARK備注VARCHAR2(100)ftp接口規(guī)范報文節(jié)點概要報文格式及示例報文示例： <Head> <MessageID>GZSW_201609222208231234</MessageID> <MessageType>xxxxx</MessageType> <Sender>GDENT</Sender> <Receiver>GZSW</Receiver> <SendTime>20160922220823</SendTime> <Version>1.0</Version> </Head> <Declaration> <NODE_CODE>10101<NODE_CODE/> <SHIP_CODE>BSY5</SHIP_CODE> <SHIP_NAME>BOSHIYUN558</SHIP_NAME> <E_VOYAGE>160329000000</E_VOYAGE> <DOCK_CODE>512345</DOCK_CODE> <DOCK_NAME>黃埔碼頭</DOCK_CODE> <BL_NO_N><BL_NO>CUX92343442</BL_NO></BL_NO_N> <SHIP_PROXY_CODE>3512</SHIP_PROXY> <SHIP_PROXY_NAME>中外運</SHIP_PROXY> <IE_ENTERPRISE_CODE>123</IE_ENTERPRISE> <IE_ENTERPRISE_NAME>廣州單一窗口</IE_ENTERPRISE> <OPERATOR>石破天</OPERATOR> <OPER_TIME>20160922220823</OPER_TIME> <CONTACTS_MOBILE>lt;/CONTACTS_MOBILE> <CUS_COMPANY_CODE>1222</CUS_COMPANY> <CUS_COMPANY_NAME>鐵石報關行</CUS_COMPANY> <IE_TYPE>I</IE_TYPE> <REMARK></REMARK> </Declaration>FTP報文文件回執(zhí)接口報文節(jié)點概要報文格式內(nèi)容說明節(jié)點節(jié)點名稱字段長度描述備注NODE_CODE狀態(tài)編碼VARCHAR2(8)必填SHIP_CODE船編VARCHAR2(50)必填SHIP_NAME船名VARCHAR2(100)必填E_VOYAGE航次VARCHAR2(20)必填ReceiveStatus接收狀態(tài)NVARCHAR2(2)必填(1：接收成功；2接收失敗)ReceiveDesc接收狀態(tài)描述NVARCHAR2(100)報文格式及示例報文示例： <Head> <MessageID>GZSW_201609222208231234</MessageID> <MessageType>xxxxx</MessageType> <Sender>GDENT</Sender> <Receiver>GZSW</Receiver> <SendTime>20160922220823</SendTime> <Version>1.0</Version> </Head> <Declaration> <NODE_CODE>10101<NODE_CODE/> <SHIP_CODE>BSY5</SHIP_CODE> <SHIP_NAME>BOSHIYUN558</SHIP_NAME> <E_VOYAGE>160329000000</E_VOYAGE> <ReceiveStatus>1</ReceiveStatus> <ReceiveDesc>接收成功</ReceiveDesc> </Declaration>Webservice接口規(guī)范服務定義服務工程：logisticsGoodsData服務定義：序號名稱方法1接受委托publicStringsubmitImplData(param1)服務參數(shù)企業(yè)接受委托數(shù)據(jù)服務包含1個服務方法submitImplData()方法，方法包含一個參數(shù)，參數(shù)采用XML數(shù)據(jù)交換格式，參數(shù)表示要發(fā)送的提交資料數(shù)據(jù)本身，如數(shù)據(jù)本身為空，使用“”空串表示。方法對應的參數(shù)如下所示：序號方法參數(shù)描述類型說明1submitImplData()param1StringXML格式的字符串param1具體示例如下：publicStringsubmitImplData(“<?xmlversion='1.0'encoding='utf-8'?><Declaration> <NODE_CODE>10101<NODE_CODE/><SHIP_CODE>BSY5</SHIP_CODE> <SHIP_NAME>BOSHIYUN558</SHIP_NAME> <E_VOYAGE>160329000000</E_VOYAGE> <DOCK_CODE>512345</DOCK_CODE> <DOCK_NAME>黃埔碼頭</DOCK_CODE> <BL_NO_N><BL_NO>CUX92343442</BL_NO></BL_NO_N> <SHIP_PROXY_CODE>3512</SHIP_PROXY> <SHIP_PROXY_NAME>中外運</SHIP_PROXY> <IE_ENTERPRISE_CODE>123</IE_ENTERPRISE> <IE_ENTERPRISE_NAME>廣州單一窗口</IE_ENTERPRISE> <OPERATOR>石破天</OPERATOR> <OPER_TIME>20160922220823</OPER_TIME> <CONTACTS_MOBILE>lt;/CONTACTS_MOBILE> <CUS_COMPANY_CODE>1222</CUS_COMPANY> <CUS_COMPANY_NAME>鐵石報關行</CUS_COMPANY> <IE_TYPE>I</IE_TYPE><REMARK></REMARK></Declaration>“)服務返回NODE_CODE狀態(tài)編碼VARCHAR2(8)必填SHIP_CODE船編VARCHAR2(50)必填SHIP_NAME船名VARCHAR2(100)必填E_VOYAGE航次VARCHAR2(20)必填ReceiveStatus接收狀態(tài)NVARCHAR2(2)必填(1：接收成功；2接收失敗)ReceiveDesc接收狀態(tài)描述NVARCHAR2(100)示例：<?xmlversion='1.0'encoding='utf-8'?><Declaration> <NODE_CODE>10101<NODE_CODE/> <SHIP_CODE>BSY5</SHIP_CODE> <SHIP_NAME>BOSHIYUN558</SHIP_NAME> <E_VOYAGE>160329000000</E_VOYAGE> <ReceiveStatus>1</ReceiveStatus> <ReceiveDesc>接收成功</ReceiveDesc> </Declaration>換單完成狀態(tài)編碼為10501功能描述用于接收企業(yè)物流貨物換單環(huán)節(jié)數(shù)據(jù)接口的服務。報文格式內(nèi)容說明節(jié)點節(jié)點名稱字段長度描述備注NODE_CODE狀態(tài)代碼VARCHAR2(5)SHIP_CODE船編VARCHAR2(50)SHIP_NAME船名VARCHAR2(100)E_VOYAGE航次VARCHAR2(20)BL_NO提單列表信息VARCHAR2(50)提單號1~9999個OPERATOR經(jīng)辦人VARCHAR2(50)CONTACTS_MOBILE聯(lián)系電話VARCHAR2(20)COMPANY_CODE換單公司代碼VARCHAR2(20)COMPANY_NAME換單公司代碼名稱VARCHAR2(100)SHIP_PROXY_COM_CODE船代公司代碼VARCHAR2(50)SHIP_PROXY_COM_NAME船代公司名稱VARCHAR2(100)OPER_TIME換單時間DATE格式：2016-06-2311:41:05IE_TYPE進出口標識CHAR(2)I:進口;E:出口REMARK備注VARCHAR2(100)ftp接口規(guī)范報文節(jié)點概要報文格式及示例報文示例： <?xmlversion="1.0"encoding="UTF-8"?> <Head> <MessageID>text</MessageID> <MessageType>xxxxx</MessageType> <Sender>text</Sender> <Receiver>text</Receiver> <SendTime>text</SendTime> <Version>text</Version> </Head> <Declaration> <NODE_CODE>10501<NODE_CODE/> <SHIP_CODE>String</SHIP_CODE> <SHIP_NAME>String</SHIP_NAME> <E_VOYAGE>String</E_VOYAGE> <DOCK_CODE>String</DOCK_CODE> <BL_NO_N><BL_NO>String</BL_NO></BL_NO_N> <SHIP_PROXY_COM_CODE>String</SHIP_PROXY_COM_CODE> <OPERATOR>String</OPERATOR> <OPER_TIME>Date</OPER_TIME> <CONTACTS_MOBILE>String</CONTACTS_MOBILE> <COMPANY_CODE>String</COMPANY_CODE> <IE_TYPE>String</IE_TYPE><REMARK></REMARK> </Declaration></Root>FTP報文文件回執(zhí)接口報文節(jié)點概要報文格式內(nèi)容說明節(jié)點節(jié)點名稱字段長度描述備注NODE_CODE狀態(tài)編碼VARCHAR2(5)必填SHIP_CODE船編VARCHAR2(50)必填SHIP_NAME船名VARCHAR2(100)必填E_VOYAGE航次VARCHAR2(20)必填ReceiveStatus接收狀態(tài)NVARCHAR2(2)必填(1：接收成功；2接手失敗)ReceiveDesc接收狀態(tài)描述NVARCHAR2(100)報文格式及示例報文示例： <Head> <MessageID>GZSW_201609222208231234</MessageID> <MessageType>xxxxx</MessageType> <Sender>GDENT</Sender> <Receiver>GZSW</Receiver> <SendTime>20160922220823</SendTime> <Version>1.0</Version> </Head> <Declaration> <NODE_CODE>10501<NODE_CODE/> <SHIP_CODE>BSY5</SHIP_CODE> <SHIP_NAME>BOSHIYUN558</SHIP_NAME> <E_VOYAGE>160329000000</E_VOYAGE> <ReceiveStatus>1</ReceiveStatus> <ReceiveDesc>接收成功</ReceiveDesc> </Declaration>Webservice接口規(guī)范服務定義服務工程：logisticsGoodsData服務定義：序號名稱方法1接受委托publicStringsubmitImplData(param1)服務參數(shù)企業(yè)換單服務包含1個服務方法submitImplData()方法，方法包含一個參數(shù)，參數(shù)采用xml數(shù)據(jù)交換格式，參數(shù)表示要發(fā)送的提交資料數(shù)據(jù)本身，如數(shù)據(jù)本身為空，使用“”空串表示。方法對應的參數(shù)如下所示：序號方法參數(shù)描述類型說明1submitImplData()param1StringXML格式的字符串示例：publicStringsubmitImplData(“<?xmlversion='1.0'encoding='utf-8'?><Declaration> <NODE_CODE>10501<NODE_CODE/><SHIP_CODE>BSY5</SHIP_CODE> <SHIP_NAME>BOSHIYUN558</SHIP_NAME> <E_VOYAGE>160329000000</E_VOYAGE> <DOCK_CODE>512345</DOCK_CODE> <DOCK_NAME>黃埔碼頭</DOCK_CODE> <BL_NO_N><BL_NO>String</BL_NO></BL_NO_N> <SHIP_PROXY_CODE>3512</SHIP_PROXY> <SHIP_PROXY_NAME>中外運</SHIP_PROXY> <IE_ENTERPRISE_CODE>123</IE_ENTERPRISE> <IE_ENTERPRISE_NAME>廣州單一窗口</IE_ENTERPRISE> <OPERATOR>石破天</OPERATOR> <OPER_TIME>20160922220823</OPER_TIME> <CONTACTS_MOBILE>lt;/CONTACTS_MOBILE> <CUS_COMPANY_CODE>1222</CUS_COMPANY> <CUS_COMPANY_NAME>鐵石報關行</CUS_COMPANY> <IE_TYPE>I</IE_TYPE><REMARK></REMARK></Declaration>“)服務返回企業(yè)換單服務的返回值采用XML數(shù)據(jù)交換格式，具體內(nèi)容如下：NODE_CODE狀態(tài)編碼VARCHAR2(5)必填SHIP_CODE船編VARCHAR2(50)必填SHIP_NAME船名VARCHAR2(100)必填E_VOYAGE航次VARCHAR2(20)必填ReceiveStatus接收狀態(tài)NVARCHAR2(2)必填(1：接收成功；2接收失敗)ReceiveDesc接收狀態(tài)描述NVARCHAR2(100)示例：<?xmlversion='1.0'encoding='utf-8'?><Declaration> <NODE_CODE>10501<NODE_CODE/> <SHIP_CODE>BSY5</SHIP_CODE> <SHIP_NAME>BOSHIYUN558</SHIP_NAME> <E_VOYAGE>160329000000</E_VOYAGE> <ReceiveStatus>1</ReceiveStatus> <ReceiveDesc>接收成功</ReceiveDesc> </Declaration>已換取設備交接單狀態(tài)編碼為11301功能描述用于接收企業(yè)物流貨物已換取設備交接單環(huán)節(jié)數(shù)據(jù)接口的服務。報文格式內(nèi)容說明節(jié)點節(jié)點名稱字段長度描述備注NODE_CODE狀態(tài)編碼VARCHAR2(5)必填SHIP_CODE船編VARCHAR2(50)SHIP_NAME船名VARCHAR2(100)E_VOYAGE航次VARCHAR2(20)BL_NO提單號VARCHAR2(50)提單號1~9999個OPERATOR經(jīng)辦人VARCHAR2(50)OPER_TIME換單時間DATE格式：2016-06-2311:41:05IE_TYPE進出口標識CHAR(2)I:進口;E:出口REMARK備注VARCHAR2(100)ftp接口規(guī)范報文節(jié)點概要報文格式及示例報文示例： <?xmlversion="1.0"encoding="UTF-8"?> <Head> <MessageID>text</MessageID> <MessageType>xxxxx</MessageType> <Sender>text</Sender> <Receiver>text</Receiver> <SendTime>text</SendTime> <Version>text</Version> </Head> <Declaration> <NODE_CODE>11301<NODE_CODE/> <SHIP_CODE>String</SHIP_CODE> <SHIP_NAME>String</SHIP_NAME> <E_VOYAGE>String</E_VOYAGE> <BL_NO_N><BL_NO>String</BL_NO></BL_NO_N> <OPERATOR>String</OPERATOR> <OPER_TIME>Date</OPER_TIME> <IE_TYPE>String</IE_TYPE> <REMARK></REMARK> </Declaration></Root>FTP報文文件回執(zhí)接口報文節(jié)點概要報文格式內(nèi)容說明節(jié)點節(jié)點名稱字段長度描述備注NODE_CODE狀態(tài)編碼VARCHAR2(5)必填SHIP_CODE船編VARCHAR2(50)必填SHIP_NAME船名VARCHAR2(100)必填E_VOYAGE航次VARCHAR2(20)必填ReceiveStatus接收狀態(tài)NVARCHAR2(2)必填(1：接收成功；2接手失敗)ReceiveDesc接收狀態(tài)描述NVARCHAR2(100)報文格式及示例報文示例： <Head> <MessageID>GZSW_201609222208231234</MessageID> <MessageType>xxxxx</MessageType> <Sender>GDENT</Sender> <Receiver>GZSW</Receiver> <SendTime>20160922220823</S

溫馨提示

  • 1. 本站所有資源如無特殊說明，都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等，如果需要附件，請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙，網(wǎng)頁內(nèi)容里面會有圖紙預覽，若沒有圖紙預覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間，僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理，對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯，并不能對任何下載內(nèi)容負責。
  • 6. 下載文件中如有侵權(quán)或不適當內(nèi)容，請與我們聯(lián)系，我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論