版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领
文档简介
广州国际贸易“单一窗口” 单一窗口物流货物全流程监控接口说明单一窗口物流货物全流程监控接口说明v1.02016年9月
修订历史日期版本描述作者2016-09-251.0初稿杜建伟
目录1. 概述 41.1. 编写目的 41.2. 背景 41.3. 阅读对象 41.4. 定义 42. 采集对接范围定义 52.1. 对接单位代码定义 52.2. 采集单位与环节关系定义 52.2.1. 进口环节 52.2.2. 出口环节 53. 数据接口协议说明 53.1. 报文文件交换方式 53.1.1. 接口功能描述 53.1.2. 报文格式要求 53.1.3. 状态编码说明 63.1.4. 报文类型定义说明 63.1.5. 报文基本结构及说明 63.1.6. 报文文件命名要求 73.2. WebService协议通讯方式 74. 数据接口说明 74.1. 接受委托 74.1.1. 功能描述 74.1.2. 报文格式内容说明 74.1.3. ftp接口规范 94.1.4. Webservice接口规范 134.2. 换单完成 154.2.1. 功能描述 154.2.2. 报文格式内容说明 154.2.3. ftp接口规范 164.2.4. Webservice接口规范 194.3. 已换取设备交接单 214.3.1. 功能描述 214.3.2. 报文格式内容说明 224.3.3. ftp接口规范 224.3.4. Webservice接口规范 26概述编写目的本文档围绕单一窗口建立物流通关货物监控平台，建设中需要企业协助提供某一环节相应的物流货物数据，本文即是在此情况下编写，用于指导企业具体提供哪些数据。单一窗口接口分为三种，一种是直接通过FTP的方式，一种是通过调用对方提供的WebService的方式。这两种方式都需要先按指定的格式生成的内容，对于报文交换的方式，则需要生成物理文件，而对于WebService的方式，则不需要生成物理文件，不存在报文命名的问题。以下是对于生成报文内容以及物理文件的要求进行说明。背景水运进出货物通关物流追踪系统主要通过采集进出口各环节状态的的数据，形成一个涵盖进出口企业、报关报检代理、船代、码头、理货公司、运输企业等与进出口贸易相关的企业以及海关、检验检疫、边检、海事、港务、口岸办等口岸管理单位及其它政府部门的状态大数据，并通过网页或移动终端的展示方式为企业提供对货物通关物流状态进行实时透明的全流程跟踪服务，同时为口岸管理部门及相关政府部门提供全方位的统计分析服务，
通过对通关物流环节的大数据智能分析，精准定位耗时长、效率低的通关环节，为压缩通关时间，促进通关效率提供更有效的决策支持。阅读对象本文档的阅读对象为系统设计、开发人员、软件测试人员、技术评审人员、技术管理人员等。定义数据接口：本文档涉及的数据接口涵盖基于Ftp文件形式的数据报文接口，以及基于http协议的Web接口。采集对接范围定义对接单位代码定义采集范围发送人/接收人名称代码备注对接企业企业XXXX此部分代码由电子口岸提供给相关企业采集单位与环节关系定义进口环节单位进出口标识涉及环节备注船代进口接受委托在货主委托船代换单完成进出口企业或报关报检代理到船公司/船代换取提货单（大船提单换小船提单，直航也需换单）已换取设备交接单报关代理向船代船公司已换取设备交接单报关报检代理进口接受委托在货主委托报关报检代理出口环节单位进出口标识涉及环节备注船代出口接受委托在货主委托船代报关报检代理出口接受委托在货主委托报关报检代理数据接口协议说明报文文件交换方式接口功能描述实现企业物流货物进口接受委托，换单，已换取设备交接单等环节数据接入到“广州国际贸易“单一窗口”平台”。单一窗口平台接收数据并入库。报文格式要求采用XML作为报文格式，字符编码统一采用UTF-8格式：encoding="UTF-8"报文应以<?xmlversion="1.0"encoding="UTF-8"?>开始。状态编码说明用于提供给企业标示某一个环节的具体状态标志，状态编码共有5位，第一位代表进出口1进口，2出口；中间两位代表具体的状态环节；后面两位代表此环节明细状态从01开始最大99，例如：10101代表是进口流程中接受委托环节第一个已接收状态。本次涉及企业提供的相关编码如下：状态编码状态描述10101接受委托10501换单完成11301已换取设备交接单报文类型定义说明报文类型编码待电子口岸提供：xxxxx报文基本结构及说明报文头节点名称节点说明节点内容说明<Message><Head><MessageID>报文唯一编号组成规则：[MessageType]_[SenderId]_[SendTime]+[4位随机数字]
注意：此处[SendTime]的格式为：yyyyMMddhhmmss<MessageType>报文类型参照本文中“报文类型定义”一节。<Sender>发送方代码参照报文接收人代码定义<Receiver>发送方代码参照报文接收人代码定义<SendTime>发送时间格式：yyyyMMddhhmmss<Version>报文版本号报文格式版本号，初始固定为“1.0”<Body>业务节点1
业务节点2
…报文文件命名要求文件名称规则为：[MessageType]_[Sender]_[SendTime]+[3位随机数字].xml其中[MessageType]名称参考报文类型定义，[Sender]代表发送方代码,[SendTime]代表发送时间，精确到秒，采用yyyyMMddhhmmss例如：SWSHIP002_GZSW_20150611103131002.xmlWebService协议通讯方式采用restfullwebservice进行实现数据接口说明接受委托状态编码为10101功能描述用于接收企业物流货物进口提交资料环节数据接口的服务。报文格式内容说明节点节点名称字段长度描述备注NODE_CODE状态编码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进出口企业代码VARCHAR2(20)IE_ENTERPRISE_NAME进出口企业代码名称VARCHAR2(100)OPERATOR经办人VARCHAR2(50)OPER_TIME时间DATE格式：2016-06-2311:41:05CONTACTS_MOBILE联系电话VARCHAR2(20)CUS_COMPANY报关报检公司代码VARCHAR2(50)CUS_COMPANY_NAME报关报检公司名称VARCHAR2(100)IE_TYPE进出口标识CHAR(2)I:进口;E:出口REMARK备注VARCHAR2(100)ftp接口规范报文节点概要报文格式及示例报文示例： <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报文文件回执接口报文节点概要报文格式内容说明节点节点名称字段长度描述备注NODE_CODE状态编码VARCHAR2(8)必填SHIP_CODE船编VARCHAR2(50)必填SHIP_NAME船名VARCHAR2(100)必填E_VOYAGE航次VARCHAR2(20)必填ReceiveStatus接收状态NVARCHAR2(2)必填(1：接收成功；2接收失败)ReceiveDesc接收状态描述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接口规范服务定义服务工程：logisticsGoodsData服务定义：序号名称方法1接受委托publicStringsubmitImplData(param1)服务参数企业接受委托数据服务包含1个服务方法submitImplData()方法，方法包含一个参数，参数采用XML数据交换格式，参数表示要发送的提交资料数据本身，如数据本身为空，使用“”空串表示。方法对应的参数如下所示：序号方法参数描述类型说明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状态编码VARCHAR2(8)必填SHIP_CODE船编VARCHAR2(50)必填SHIP_NAME船名VARCHAR2(100)必填E_VOYAGE航次VARCHAR2(20)必填ReceiveStatus接收状态NVARCHAR2(2)必填(1：接收成功；2接收失败)ReceiveDesc接收状态描述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>换单完成状态编码为10501功能描述用于接收企业物流货物换单环节数据接口的服务。报文格式内容说明节点节点名称字段长度描述备注NODE_CODE状态代码VARCHAR2(5)SHIP_CODE船编VARCHAR2(50)SHIP_NAME船名VARCHAR2(100)E_VOYAGE航次VARCHAR2(20)BL_NO提单列表信息VARCHAR2(50)提单号1~9999个OPERATOR经办人VARCHAR2(50)CONTACTS_MOBILE联系电话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接口规范报文节点概要报文格式及示例报文示例： <?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报文文件回执接口报文节点概要报文格式内容说明节点节点名称字段长度描述备注NODE_CODE状态编码VARCHAR2(5)必填SHIP_CODE船编VARCHAR2(50)必填SHIP_NAME船名VARCHAR2(100)必填E_VOYAGE航次VARCHAR2(20)必填ReceiveStatus接收状态NVARCHAR2(2)必填(1：接收成功；2接手失败)ReceiveDesc接收状态描述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接口规范服务定义服务工程：logisticsGoodsData服务定义：序号名称方法1接受委托publicStringsubmitImplData(param1)服务参数企业换单服务包含1个服务方法submitImplData()方法，方法包含一个参数，参数采用xml数据交换格式，参数表示要发送的提交资料数据本身，如数据本身为空，使用“”空串表示。方法对应的参数如下所示：序号方法参数描述类型说明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>“)服务返回企业换单服务的返回值采用XML数据交换格式，具体内容如下：NODE_CODE状态编码VARCHAR2(5)必填SHIP_CODE船编VARCHAR2(50)必填SHIP_NAME船名VARCHAR2(100)必填E_VOYAGE航次VARCHAR2(20)必填ReceiveStatus接收状态NVARCHAR2(2)必填(1：接收成功；2接收失败)ReceiveDesc接收状态描述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>已换取设备交接单状态编码为11301功能描述用于接收企业物流货物已换取设备交接单环节数据接口的服务。报文格式内容说明节点节点名称字段长度描述备注NODE_CODE状态编码VARCHAR2(5)必填SHIP_CODE船编VARCHAR2(50)SHIP_NAME船名VARCHAR2(100)E_VOYAGE航次VARCHAR2(20)BL_NO提单号VARCHAR2(50)提单号1~9999个OPERATOR经办人VARCHAR2(50)OPER_TIME换单时间DATE格式：2016-06-2311:41:05IE_TYPE进出口标识CHAR(2)I:进口;E:出口REMARK备注VARCHAR2(100)ftp接口规范报文节点概要报文格式及示例报文示例： <?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报文文件回执接口报文节点概要报文格式内容说明节点节点名称字段长度描述备注NODE_CODE状态编码VARCHAR2(5)必填SHIP_CODE船编VARCHAR2(50)必填SHIP_NAME船名VARCHAR2(100)必填E_VOYAGE航次VARCHAR2(20)必填ReceiveStatus接收状态NVARCHAR2(2)必填(1：接收成功；2接手失败)ReceiveDesc接收状态描述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. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 知名企业施工现场临水、电设计及计算
- 2024至2030年等径直接铜接头项目投资价值分析报告
- 2024至2030年法国香水香皂项目投资价值分析报告
- 营业用房长期租赁合同范例
- 薯类制品批发合同范例
- 陕西师范大学《仪器分析化学类》2023-2024学年第一学期期末试卷
- 旧车报废销户合同范例
- 2024年芙蓉全蔬汤项目可行性研究报告
- 钻空施工合同范例
- 管道材料合同范例
- 水果削皮机的工业工程设计论文
- 空压站设备安装施工组织设计方案（空压站设备安装）
- 肝癌患者的护理疑难病例讨论记录文本
- 四大经典之温病
- 石化装置动设备操作规程
- 海花岛(海南儋州)民宿众筹计划书
- 注塑件通用技术条件
- 人大代表选举主持词_1
- KingSCADA初级教程工程安全和用户管理
- 消防安装工程质量通病及防治措施
- 植物大战僵尸儿童填色画2
评论
0/150
提交评论