添加受理单订阅接口

README.md

@@ -5,8 +5,9 @@
 <!-- TOC -->
 
 - [TMS/CTMS第三方接口文档](#tmsctms第三方接口文档)
-    - [接口简介](#接口简介)
+    - [接口简介(请仔细阅读!)](#接口简介请仔细阅读)
     - [接口说明](#接口说明)
+    - [常见问题](#常见问题)
 - [接口凭证](#接口凭证)
     - [获取登陆凭证接口](#获取登陆凭证接口)
     - [更新登陆凭证接口](#更新登陆凭证接口)
@@ -17,9 +18,9 @@
     - [修改订单接口](#修改订单接口)
     - [撤销订单接口](#撤销订单接口)
     - [订单货物类接口](#订单货物类接口)
-            - [追加订单货物接口](#追加订单货物接口)
-            - [修改订单货物接口](#修改订单货物接口)
-            - [删除订单货物接口](#删除订单货物接口)
+        - [追加订单货物接口](#追加订单货物接口)
+        - [修改订单货物接口](#修改订单货物接口)
+        - [删除订单货物接口](#删除订单货物接口)
 - [车次类接口](#车次类接口)
     - [创建车次接口](#创建车次接口)
 - [订阅类接口](#订阅类接口)
@@ -27,6 +28,8 @@
     - [取消订单订阅接口](#取消订单订阅接口)
     - [车次订阅接口](#车次订阅接口)
     - [取消车次订阅接口](#取消车次订阅接口)
+    - [受理单订阅接口](#受理单订阅接口)
+    - [取消受理单订阅接口](#取消受理单订阅接口)
 - [受理单类接口](#受理单类接口)
     - [创建受理单接口](#创建受理单接口)
     - [更新受理单接口](#更新受理单接口)
@@ -43,7 +46,7 @@
 
 <!-- /TOC -->
 
-## 接口简介
+## 接口简介(请仔细阅读!)
 
 本文档为3TMS/CTMS第三方开放接口文档，操作流程为：
 1. 注册并开通TMS账号（正式环境账号联系实施，应该已经开通过了）；
@@ -77,6 +80,9 @@
 - **message**：错误信息，当接口调用失败（状态码为 非200）时，返回的错误信息
 - **data**：返回数据，接口调用成功（状态码为 200）之后返回的数据
 
+## 常见问题
+[有问题先看这里！](PROBLEMS.md)
+
 # 接口凭证
 
 ## 获取登陆凭证接口
@@ -789,7 +795,7 @@
 
 ## 订单货物类接口
 
-#### 追加订单货物接口
+### 追加订单货物接口
 
 **简要描述：** 追加订单货物，请使用[修改订单接口](#修改订单接口)
 
@@ -831,7 +837,7 @@
 }
 ```
 
-#### 修改订单货物接口
+### 修改订单货物接口
 
 **简要描述：** 修改订单货物，请使用[修改订单接口](#修改订单接口)
 
@@ -873,7 +879,7 @@
 ```
 
 
-#### 删除订单货物接口
+### 删除订单货物接口
 
 **简要描述：** 删除订单货物，请使用[修改订单接口](#修改订单接口)
 
@@ -1171,6 +1177,91 @@
 }
 ```
 
+## 受理单订阅接口
+
+**简要描述：** 受理单订阅，请先阅读<a href="PROBLEMS.md#车次订阅接口与订单订阅接口">常见问题</a>!!!
+
+**请求 URL：** `/customer_order/subscribe`
+
+**请求方式：** POST
+
+**需要认证：** 是
+
+**请求参数：**
+
+| 参数名 | 必选 | 类型 | 说明 |
+|:----:|:---:|:-----:|:-----:|
+| `states` | 是 | `String` | 601:受理单签收，多个状态之间用','隔开  |
+| `callbackUrl` | 是 | `String` | 回调地址，以http://或https://开头，支持每个用户使用不同的回调地址 |
+
+
+**返回示例**
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "message": null
+}
+```
+- 调用失败示例
+
+```java
+{
+    "status": 500,
+    "message": "xxx"
+}    
+```
+
+- 车次订阅返回报文：
+
+```java
+{
+    "customerOrderNumber": "S1910111512348435", /*受理单号*/
+    "isFinished": true, /*受理单是否完成*/
+    "arrivedTime": 1571971794, /*到达时间，时间戳，精确到秒*/
+    "lastSignTime": 1571971794, /*最后一个分段的签收时间，时间戳，精确到秒*/
+    "orderState": 3000, /*受理单状态*/
+    "subscribeState": 601, /*订阅的状态*/
+    "messageTimeStamp": 1571971799 /*消息生成时的时间戳，精确到秒*/
+}
+```
+
+## 取消受理单订阅接口
+
+**简要描述：** 取消受理单订阅
+
+**请求 URL：** `/customer_order/unsubscribe`
+
+**请求方式：** POST
+
+**需要认证：** 是
+
+**请求参数：**
+
+| 参数名 | 必选 | 类型 | 说明 |
+|:----:|:---:|:-----:|:-----:|
+
+**返回示例**
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "message": null
+}
+```
+- 调用失败示例
+
+```java
+{
+    "status": 500,
+    "message": ""
+}
+```
+
 # 受理单类接口
 
 ## 创建受理单接口