运输单删除
运输单删除
| 版本号 | 文档 | 说明 |
|---|---|---|
| 0.1 | 当前版本文档 |
oTMS同时在生产环境和测试环境中提供Web Service接口，其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
目前对该接口的调用限制为每个公司每秒最多10个请求
公共参数
| 环境 | HTTP请求方法 | HTTPS请求地址 | 请求主体MIME类型 | 响应主体MIME类型 |
|---|---|---|---|---|
| 正式环境 | PUT | https://login.otms.cn/ws/jobSheetDelete | application/xml | application/xml |
| 沙箱环境 | PUT | https://demo.otms.cn/ws/jobSheetDelete | application/xml | application/xml |
请求参数
| 字段名 | 位置 | 是否必填 | 描述 | Schema |
|---|---|---|---|---|
| body | body | 是 | 运输单删除请求 | JobSheetDeleteRequest |
| Authorization | header | Basic Authorization。如果不为空，则优先使用该值作身份认证。否则使用请求报文中的用户名与密码 | string |
响应参数
| 状态码 | 描述 | 响应模型 |
|---|---|---|
| 200 | successful operation | JobSheetDeleteResponse |
JobSheetDelete
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| sequence | integer (int32) | 是 | 序列数 | |
| jobSheetNumber | string | 否 | 运输单号 | |
| externalShipmentId | string | 否 | 运输单外部识别号 |
JobSheetDeleteRequest
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| version | string | 否 | 请求的版本号 | |
| login | string | 否 | 用户名。用于 API 调用者身份认证。如果请求头中的Authorization不为空，则该值会被忽略。 | |
| password | string | 否 | 密码。用于 API 调用者身份认证。如果请求头中的Authorization不为空，则该值会被忽略。 | |
| jobSheets | array[JobSheetDelete] | 是 | 需要删除的运输单列表。单次删除的最大数量为100 |
JobSheetDeleteResponse
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| version | string | 是 | 响应版本号 | |
| responseCode | string | 否 | 全局的反馈代码 | |
| jobSheets | array[JobSheetDeleteResult] | 否 | 运输单删除结果详细信息 |
JobSheetDeleteResult
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| sequence | integer (int32) | 是 | 序列数 | |
| jobSheetNumber | string | 否 | 运输单号 | |
| externalShipmentId | string | 否 | 运输单外部识别号 | |
| status | string | 否 | 响应状态 | |
| code | string | 是 | 响应码 | |
| msg | string | 否 | 响应信息 |
请求示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetDeleteRequest version="0.1" login="login" password="password">
<jobSheets>
<jobSheet sequence="1">
<jobSheetNumber>JSSH00105000025</jobSheetNumber>
<externalShipmentId>JSSH00105000025</externalShipmentId>
</jobSheet>
<jobSheet sequence="2">
<jobSheetNumber>JSSH00105000024</jobSheetNumber>
<externalShipmentId>JSSH00105000024</externalShipmentId>
</jobSheet>
</jobSheets>
</jobSheetDeleteRequest>响应示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetDeleteResponse version="0.1">
<responseCode></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>109</code>
<msg>Invalid job sheet state</msg>
</jobSheet>
</jobSheets>
</jobSheetDeleteResponse>
全局反馈代码
| 反馈代码 | 说明 |
| 0 | 客户验证失败。 |
| 1 | 不支持的请求版本。 |
| 2 | 超过最大请求数（100） |
| 3 | 请求错误 |
| 4 | 服务器繁忙 |
单个请求反馈代码
| 反馈代码 | 说明 |
| 100 | 成功 |
| 101 | 没有找到运输单 |
| 109 | 运输单状态错误 |