浏览代码

更新接口文档:新增批量解绑受理单设备接口

gmw 6 年之前
父节点
当前提交
7a3eeb1fb3
共有 1 个文件被更改,包括 44 次插入1 次删除
  1. 44 1
      README.md

+ 44 - 1
README.md

@@ -30,6 +30,7 @@
 - [更新受理单接口](#更新受理单接口)
 - [批量查询受理单接口](#批量查询受理单接口)
 - [撤销受理单接口](#撤销受理单接口)
+- [批量解绑受理单设备](#批量解绑受理单设备)
 - [错误码说明](#错误码说明)
 - [测试代码](#测试代码)
 
@@ -37,8 +38,9 @@
 
 本文档为CTMS第三方开放接口文档,操作流程为:
 1. 注册并开通CTMS账号(测试环境账号联系对接人员);
-2. 获取接口访问令牌(token令牌只需获取一次即可,有效期为一年)
+2. 获取接口访问令牌(token令牌只需获取一次即可,有效期为一年)
 3. 调用CTMS提供的接口(需要先获取令牌(access_token));
+4. 请使用主账号获取对应的token再调用其他接口
 
 - **接口地址**:测试环境=http://api.test.56ctms.com ,正式环境=http://api.56ctms.com
 - **获取接口访问令牌**: /login.html?redirectUri=你们的回调地址(获取令牌(access_token))  (PS:输入申请到的CTMS账号密码)
@@ -1736,6 +1738,47 @@ CustomerOrderEntity {
 ```
 
 
+## 批量解绑受理单设备
+
+**简要描述:** 批量解绑受理单设备,
+
+**请求 URL:** `/customer_order/batch_unbind_devices`
+
+**请求方式:** POST, GET
+
+**需要认证:** 是
+
+**请求参数:**
+
+| 参数名 | 必选 | 类型 | 说明 |
+|:----:|:---:|:-----:|:-----:|
+| `orders` | 是 | `Array<受理单号>` | 受理单号列表 |
+
+**返回示例**
+
+```
+{
+    "code": 200,
+    "message": null,
+    "data": {}
+}
+```
+- 调用失败示例
+
+```
+1.受理单号列表中存在未绑定设备的受理单:
+{
+    "message": "受理单S1811011025811886未绑定设备!",
+    "status": 500
+}
+
+2.受理单查询不到,请确认受理单是否存在,或者是否使用主账号调用的接口:
+{
+    "message": "受理单不存在!",
+    "status": 500
+}
+```
+
 ## 错误码说明
 
 | 错误码 |  说明 |