运单号合法性校验接口-速运类API
EXP_RECE_VALIDATE_WAYBILLNO
1. 功能描述
2. 接口定义
2.1. 公共参数
2.2. 公共请求参数
序号 |
参数列表 |
类型 |
是否必传 |
含义 |
1 |
已作废 |
String(64) |
是 |
|
2 |
requestID |
String(40) |
是 |
请求唯一号UUID |
3 |
serviceCode |
String(50) |
是 |
接口服务代码 |
4 |
timestamp |
long |
是 |
调用接口时间戳 |
5 |
已作废 |
String(128) |
条件 |
数字签名,使用数字签名方式认证时必填 签名方法参考:数字签名认证说明 |
6 |
expiresIn |
Number |
条件 |
已作废,使用OAuth2方式认证时必填 获取方法参考:OAuth2认证说明 |
7 |
msgData |
String |
是 |
业务数据报文 |
2.3. 请求参数\
# |
元素名 |
类型(约束) |
必填 |
默认值 |
描述 |
1 |
waybillNo |
String(15) |
Y |
|
运单号 (支持12位或者15位运单号) |
2.4. 公共响应参数
# |
属性名 |
类型(约束) |
必填 |
默认值 |
描述 |
1 |
success |
String |
是 |
|
true 请求成功,false 请求失败 |
2 |
errorCode |
String |
是 |
|
错误编码,S0000成功 |
3 |
errorMsg |
String |
是 |
|
错误描述 |
4 |
msgData |
String |
是 |
|
返回的详细数据 |
2.5. 响应参数\
# |
元素名 |
类型(约束) |
必填 |
默认值 |
描述 |
1 |
success |
boolean |
Y |
|
成功返回true;失败返回false |
2 |
errorCode |
String |
N |
|
失败原因代码,如4001 |
3 |
errorMsg |
String |
N |
|
失败原因,失败时记录具体原因,如系统异常 |
4 |
msgData |
String |
N |
|
运单号合法,返回true;否则返回false; |
2.6. 请求示例\应用场景(JSON)示例
请求报文:
{
"waybillNo":"SF1040275268927"
}
2.7. 返回示例\应用场景(JSON)示例
响应报文:
{
"success": true,
"errorCode": "S0000",
"errorMsg": null,
"msgData": true
}
{
"success": true,
"errorCode": "S0000",
"errorMsg": null,
"msgData": false
}
3.1. 错误代码
3.1 (API)平台结果代码列表
3.2 业务异常代码
# |
errorCode |
描述 |
1 |
S0000 |
成功 |
2 |
S0001 |
非法的JSON格式 |
3 |
S0002 |
必填参数%s为空 |
4 |
S0003 |
系统发生数据错误或运行时异常 |
5 |
S0004 |
参数%s超过最大长度%d |
6 |
S0005 |
参数超过最大值 |
7 |
S0006 |
参数%s不能小于%d |
8 |
S0007 |
参数%s数据类型错误 |