省网络货运信息交互系统接口规范.docxVIP

附件3

省网络货运信息交互系统接口规范

目录

TOC\z\o1-3\u\h省网络货运信息交互系统接口规范 1

目录 2

第1章接口 1

1.1报文属性 1

1.2接口参数 2

1.3返回结果 2

1.4处理结果编码 2

第2章接口描述 3

2.1电子运单上传 3

2.2企业资料上传 8

2.3合同信息上传 10

2.4质量和信用数据上传 12

2.5资金流水单上传 14

2.6车辆基本信息上传 15

2.7驾驶员基本信息上传 17

PAGE

PAGE19

PAGE

PAGE19

第1章接口

1.1报文属性

序号

属性名称

说明

1

报文层

标识数据元在报文结构中的位置和层次关系。

2

英文名称

数据元和段组的英文标记名，可用作可扩展标记语言（XML）

标记名，段组是由多个数据元构成的数据实体。

3

中文名称

对数据元的中文描述

4

约束/出现次数

数据元在报文中重复出现的次数

a)0..1——数据元值域可填，且出现一次；

b)0..n——数据元值域可填，且可出现多次；

c)1..1——数据元值域必填，且出现一次；

d)1..n——数据元值域必填，且可出现多次。

5

数据格式

数据格式中使用的字符含义如下：

a)a=字母字符；

b)n=数字字符；

c)an=字母数字汉字字符；

d)..=字符型数据的最小长度到最大长度的分隔符；

e)，=区分数字字符个数与小数点后小数位数的分隔符，即“，”前为数字字符个数，“，”后为小数点后小数位数；

fDhhmmss=“YYYY”表示年份，“MM”表示月份，“DD”表示日期，表示小时，“mm”表示分钟，“ss”表示秒，可以视具体实际情况组合使用。

示例1：

an3..8表示最大长度为8，最小长度为3的不定长字符。

示例2：

an5(aannn)表示定长5个字母数字字符，前2个为字母字符，后3个为数字字符。

示例3：

n..8,4表示该数值最大长度为八位数字字符、小数点后四位数字。

6

引用文件

代码型数据元值域引用的标准。

7

说明

对数据元的简要解释和应用说明。

1.2接口参数

接口采用的post方式，requestBody为xml的内容。

参数名

类型

说明

必填

业务数据

request

XML格式数据

是

1.3返回结果

返回结果为XML字符串。

root

code/code——code表示返回的结果编码

data/data——返回数据内容

description/description——错误信息描述

isSuccesstrue/isSuccess——接口请求标识【true表示正常，false表示接口抛出异常信息】

/root

1.4处理结果编码

序号

状态码

描述

1

200

正常

2

10000

必填参数内容为空

2

10001

数字格式错误

4

10002

日期格式错误

5

10003

字段值转换错误

6

10004

其他异常

7

10005

报文非合法的

8

11001

获取对应的字段数据值错误

9

404

没有对应的api接口方法

第2章接口描述

2.1电子运单上传

序号

报文层

英文名称

中文名称

约束出现次数

数据格式

说明

1

1

root

根

1..1

2

2

header

报文头

1..1

3

3

报文参考号

1..1

an..256

接口方法名称

4

2

body

报文体

1..1

5

3

stOrder

订单

1..n

6

4

originalDocumentNumber

原始单号

1..1

an..35

上游企业委托运输单号

7

4

shippingNoteNumber

托运单号

1..1

an..20

无车承运人电子路单号

8

4

serial

分段分单号

1..1

an..4

必填，分段运输和多车运输由四位数字组成，前两位代表一单多车的序号，后两位代表分段序号。若运输形式为一单一车填0000。

9

4

vehicleCount

运输总车辆数

1..1

n..4

必填，同一运单号的货物总共使用的运输车辆总数。

10

4

transportTypeCode

运输组织类型代码

1..1

n..2

必填，参照不代码集。

11

4

transportation

运输组织

1..1

an..20

运输组织分为传统运输、多式联运、甩挂运输、共同配送

12

4

承运人

1..1

an..512

无车承运人试点企业名称

13

4

unifiedCreditIdentifier

统一社会信用代码