没有合适的资源?快使用搜索试试~ 我知道了~
单一窗口进出口货物申报接口说明.doc
需积分: 5 0 下载量 63 浏览量
2023-10-06
23:23:24
上传
评论
收藏 944KB DOC 举报
温馨提示
试读
21页
单一窗口进出口货物申报接口说明.doc
资源推荐
资源详情
资源评论
“单一窗口”进出口货物申报接口说明
1
“单一窗口”
进出口货物申报
接口说明
2015 年 11 月
修订历史
日期
版本
描述
作者
2015-12-28
1.1
初稿
何智健
“单一窗口”进出口货物申报接口说明
2
目录
1. 文档说明 ..................................................................................................................................3
1.1. 文档描述 ......................................................................................................................3
1.2. 阅读对象 ......................................................................................................................3
1.3. 接口协议 ......................................................................................................................3
1.4. 接口功能说明 ..............................................................................................................3
1.5. 接口使用前提条件 ......................................................................................................3
2. 数据接口使用说明 ..................................................................................................................3
2.1. 使用环境 ......................................................................................................................3
2.2. 访问地址及参数 ..........................................................................................................3
2.3. 报文编码 ......................................................................................................................4
2.4. 结果报文说明 ..............................................................................................................4
2.4.1. 报文节点概要...................................................................................................4
2.4.2. 消息体定义 ......................................................................................................4
2.4.3. 报文示例 ........................................................................................................20
“单一窗口”进出口货物申报接口说明
3
1. 文档说明
1.1. 文档描述
本文档主要描述通过接口的方式来获取本企业在“单一窗口”平台申报的进出货物申报
数据,以及相应回执接口,作为接口开发人员实现接口功能设计的参考。
1.2. 阅读对象
系统分析人员、接口开发人员、维护人员。
1.3. 接口协议
接口采用 HTTP 方式,基于 Restful 方式的设计,接口中的业务数据以及接口返回结果
采用 Xml 格式进行封装, 格式定义详细见 3.3.2。
1.4.接口功能说明
1) 提供获取本企业在“单一窗口”平台申报的进出口货物申报数据的接口。
通过该接口可以一次获取 24 小时内的申报数据,并通过 xml 的格式返回对应
的数据;系统不设置重复获取标识,企业可多次重复获取时间区间内的所有申报记
录,并自行对相同数据进行处理。
2) 提供获取本企业在“单一窗口”平台申报的进出口货物申报的回执接口。
1.5.接口使用前提条件
1、 企业已经“单一窗口”平台开户并获得相应的登陆用户及密码。
2. 数据接口使用说明
2.1. 使用环境
操作系统:windows 或 Linux 等常用操作系统
2.2. 访问地址及参数
调用地址:
http://<DOMAIN>/cargodecl/restful/operatorCompany/export/
HTTP 方法:POST
传入参数:
参数标识
参数名称
参数类型
长度
必须传入
(Y/N)
参数格式
userName
用户帐号
字符串
30
Y
电子口岸分配的帐户名,请联调电子口岸获
取
password
帐号密码
字符串
50
Y
加密后的密码,请联调电子口岸获取
beginTime
开始时间
字符串
14
Y
格式为 yyyyMMddHHmmSS,如
“单一窗口”进出口货物申报接口说明
4
endTime
结束时间
字符串
14
Y
20151017140310;
开始时间与结束时间相隔不得超过 24 小时;
ioFlag
进出口标识
字符串
1
Y
0:进口
1:出口
messageType
申报类型
字符串
1
N
要获取的申报数据类型:
0:报关单及报检单(默认)
1:仅报检单
2:仅报关单
调用示例:
$.ajax({
url:" http://www.singlewindow.gz.cn/CargoDeclaration/restful/operatorCompany/export/",
data:userName=admin&password=XXX&beginTime=20151016140310&endTime=20151017140310&ioFlag=0&messageTy
pe=0
})
2.3. 报文编码
报文编码统一采用 UTF-8 格式。
2.4. 结果报文说明
2.4.1. 报文节点概要
图 2-1 报文格式示例
2.4.2. 消息体定义
进出口业务信息[Message]由以下主要节点组成:
节点
节点名称
描述
校验规则
[Result]
结 果 信 息 描
描述结果信息,包括结果代
出现 1 次,至多 1 次
“单一窗口”进出口货物申报接口说明
5
述
码,结果描述
[CargoDataList]
报 文 数 据 节
点
用于存放查询的报文结果
出现 1 次,至多 1 次
处理结果描述[Result]由以下节点组成:
节点
节点名称
描述
校验规则
[ResultCode]
处 理 结 果 代
码
描述结果代码信息
1/成功;2/失败
出现 1 次,至多 1 次
[ResultDesc]
处 理 结 果 描
述
显示错误信息
出现 1 次,至多 1 次
查询结果数据描述[CargoDataList]由以下节点组成:
节点
节点名称
描述
校验规则
[CargoData]
货 物 数 据 子
节点
单个关检号对应的报关及报
检数据对应一个节点
出现 0 次,至多 N 次
[Customs]
海关数据项
详细的海关数据描述,不含
商品信息
出现 0 次,至多 1 次
[CIQ]
国检数据项
详细的国检数据描述,不含
商品信息
出现 0 次,至多 1 次
[GoodsList]
商 品 货 物 信
息
详细的商品货物信息数据描
述。此节点下面分为海关商
品货物信息[Customs]和国检
商 品 货 物 信 息 [CIQ] ,
[Customs] 和 [CIQ] 既 可 以 单
独出现,也可以同时出现,
分别表示报关、报检或者联
合关检
仅出现1次
[ContainerList]
集装箱信息
详细的集装箱数据描述
出现 0 次,至多 N 次
表格 2-3
2.4.2.1. 进口海关数据项[Customs]
填写说明
父节点
子节点
节点名称
字段类型
必填
其它约束
[DeclPort]
申报口岸代码
String(4)
Y
参见海关关区代
码
[ContractNo]
合同协议号
String(32)
Y
[BillNo]
提运单号
String(32)
Y
[TrafName]
运输工具名称
String(26)
Y
[VoyageNo]
航次号
String(32)
Y
Customs
DeclHea
d
( 海 关 基
[IEPort]
进口口岸代码
String(4)
Y
参见海关关区代
码
剩余20页未读,继续阅读
资源评论
产品经理自我修养
- 粉丝: 230
- 资源: 7325
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功