运输单分配司机
将运输单分配给司机
版本号 | 文档 | 说明 |
---|---|---|
0.1 | 当前版本文档 |
oTMS同时在生产环境和测试环境中提供Web Service接口,其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况,会对API账号的调用进行限制,甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况,会对API账号的调用进行限制,甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
目前对该接口的调用限制为每个公司每秒最多10个请求
公共参数
环境 | HTTP请求方法 | HTTPS请求地址 | 请求主体MIME类型 | 响应主体MIME类型 |
---|---|---|---|---|
正式环境 | PUT | https://login.otms.cn/ws/jobsheet/driver | application/xml | application/xml |
沙箱环境 | PUT | https://demo.otms.cn/ws/jobsheet/driver | application/xml | application/xml |
请求参数
字段名 | 位置 | 是否必填 | 描述 | Schema |
---|---|---|---|---|
body | body | 是 | 运输单分配司机请求 | JobSheetAssignmentRequest |
Authorization | header | Basic Authorization。如果不为空,则优先使用该值作身份认证。否则使用请求报文中的用户名与密码 | string |
响应参数
状态码 | 描述 | 响应模型 |
---|---|---|
200 | successful operation | JobSheetAssignmentResponse |
JobSheetAssignment
字段名 | 类型 | 是否必填 | 描述 | 示例 |
---|---|---|---|---|
sequence | integer (int32) | 是 | 序列数 | |
jobSheetNumber | string | 否 | 运输单号 | |
externalShipmentId | string | 否 | 运输单外部识别号 | |
truckPlate | string | 否 | 车牌号 | |
driverMobile | string | 否 | 司机手机号 |
JobSheetAssignmentRequest
字段名 | 类型 | 是否必填 | 描述 | 示例 |
---|---|---|---|---|
version | string | 否 | 请求的版本号 | |
login | string | 否 | 用户名。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。 | |
password | string | 否 | 密码。用于 API 调用者身份认证。如果请求头中的Authorization不为空,则该值会被忽略。 | |
jobSheets | array[JobSheetAssignment] | 否 | 需要分配司机的运输单列表。单次分配的最大数量为100 |
JobSheetAssignmentResponse
字段名 | 类型 | 是否必填 | 描述 | 示例 |
---|---|---|---|---|
version | string | 是 | 响应版本号 | |
responseCode | string | 否 | 全局的反馈代码 | |
jobSheets | array[JobSheetAssignmentResult] | 否 | 运输单分车结果详细信息 |
JobSheetAssignmentResult
字段名 | 类型 | 是否必填 | 描述 | 示例 |
---|---|---|---|---|
sequence | integer (int32) | 是 | 序列数 | |
jobSheetNumber | string | 否 | 运输单号 | |
externalShipmentId | string | 否 | 运输单外部识别号 | |
status | string | 否 | 响应状态 | |
code | string | 是 | 响应码 | |
msg | string | 否 | 响应信息 |
请求示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetAssignmentRequest version="0.1" login="username" password="password">
<jobSheets>
<jobSheet sequence="1">
<jobSheetNumber>JSSH00105000025</jobSheetNumber>
<externalShipmentId>JSSH00105000025</externalShipmentId>
<truckPlate>沪A11111</truckPlate>
<driverMobile>13811111111</driverMobile>
</jobSheet>
<jobSheet sequence="2">
<jobSheetNumber>JSSH00105000024</jobSheetNumber>
<externalShipmentId>JSSH00105000024</externalShipmentId>
<truckPlate>沪A11112</truckPlate>
<driverMobile>13811111111</driverMobile>
</jobSheet>
</jobSheets>
</jobSheetAssignmentRequest>
响应示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetAssignmentResponse version="0.1">
<responseCode/>
<jobSheets>
<jobSheet sequence="1">
<jobSheetNumber>JSSH00105000025</jobSheetNumber>
<externalShipmentId>JSSH00105000025</externalShipmentId>
<status>SUCCEED</status>
<code>100</code>
<msg>Success</msg>
</jobSheet>
<jobSheet sequence="2">
<jobSheetNumber>JSSH00105000024</jobSheetNumber>
<externalShipmentId>JSSH00105000024</externalShipmentId>
<status>FAILED</status>
<code>102</code>
<msg>Driver not found</msg>
</jobSheet>
</jobSheets>
</jobSheetAssignmentResponse>
全局反馈代码
反馈代码 | 说明 |
0 | 客户验证失败。 |
1 | 不支持的请求版本。 |
2 | 超过最大请求数(100) |
3 | 请求错误 |
4 | 服务器繁忙 |
单个请求反馈代码
反馈代码 | 说明 |
100 | 成功 |
101 | 没有找到运输单 |
102 | 没有找到司机 |
103 | 订单状态错误 |
104 | 订单分配司机失败 |
105 | 运输单分配司机失败 |
106 | 车辆和订单不匹配 |
107 | 推送订单分配事件失败 |
108 | 通知卡车司机失败 |
109 | 运输单状态错误 |
110 | 订单未到已释放状态 |