Browse Source

新增接口

gmw 4 years ago
parent
commit
5b38bab1f1
1 changed files with 125 additions and 12 deletions
  1. 125 12
      README.md

+ 125 - 12
README.md

@@ -14,11 +14,14 @@
     - [创建运单接口](#%E5%88%9B%E5%BB%BA%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
 - [基础信息类接口](#%E5%9F%BA%E7%A1%80%E4%BF%A1%E6%81%AF%E7%B1%BB%E6%8E%A5%E5%8F%A3)
     - [批量创建司机接口](#%E6%89%B9%E9%87%8F%E5%88%9B%E5%BB%BA%E5%8F%B8%E6%9C%BA%E6%8E%A5%E5%8F%A3)
+    - [修改司机信息接口](#%E4%BF%AE%E6%94%B9%E5%8F%B8%E6%9C%BA%E4%BF%A1%E6%81%AF%E6%8E%A5%E5%8F%A3)
     - [批量创建车辆接口](#%E6%89%B9%E9%87%8F%E5%88%9B%E5%BB%BA%E8%BD%A6%E8%BE%86%E6%8E%A5%E5%8F%A3)
+    - [修改车辆信息接口](#%E4%BF%AE%E6%94%B9%E8%BD%A6%E8%BE%86%E4%BF%A1%E6%81%AF%E6%8E%A5%E5%8F%A3)
     - [批量创建收款人接口](#%E6%89%B9%E9%87%8F%E5%88%9B%E5%BB%BA%E6%94%B6%E6%AC%BE%E4%BA%BA%E6%8E%A5%E5%8F%A3)
+    - [修改收款人信息接口](#%E4%BF%AE%E6%94%B9%E6%94%B6%E6%AC%BE%E4%BA%BA%E4%BF%A1%E6%81%AF%E6%8E%A5%E5%8F%A3)
 - [财务类接口](#%E8%B4%A2%E5%8A%A1%E7%B1%BB%E6%8E%A5%E5%8F%A3)
     - [核销接口](#%E6%A0%B8%E9%94%80%E6%8E%A5%E5%8F%A3)
-    - [支付并核销接口](#%E6%94%AF%E4%BB%98%E5%B9%B6%E6%A0%B8%E9%94%80%E6%8E%A5%E5%8F%A3)
+    - [撤销核销接口](#%E6%92%A4%E9%94%80%E6%A0%B8%E9%94%80%E6%8E%A5%E5%8F%A3)
 - [接口参数说明](#%E6%8E%A5%E5%8F%A3%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E)
     - [运单](#%E8%BF%90%E5%8D%95)
     - [货物](#%E8%B4%A7%E7%89%A9)
@@ -196,6 +199,7 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
     "message": null    
 }
 ```
+
 - 调用失败示例
 
 ```java
@@ -235,6 +239,43 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
     "message": null
 }
 ```
+
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+## 修改司机信息接口
+
+**简要描述:** 修改司机信息,该接口为覆盖更新,故未变更的字段也需要传入,否则会置空
+
+**请求 URL:** `/driver/update`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 60次/分钟
+
+**请求参数:**
+
+请参考:[司机](#司机)
+
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+
 - 调用失败示例
 
 ```java
@@ -244,6 +285,7 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 }
 ```
 
+
 ## 批量创建车辆接口
 
 **简要描述:** 批量创建车辆
@@ -271,6 +313,44 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
     "message": null
 }
 ```
+
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+
+## 修改车辆信息接口
+
+**简要描述:** 修改车辆信息,该接口为覆盖更新,故未变更的字段也需要传入,否则会置空
+
+**请求 URL:** `/vehicle/update`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 60次/分钟
+
+**请求参数:**
+
+请参考:[车辆](#车辆)
+
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+
 - 调用失败示例
 
 ```java
@@ -280,6 +360,7 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 }
 ```
 
+
 ## 批量创建收款人接口
 
 **简要描述:** 批量创建收款人
@@ -316,6 +397,42 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 }
 ```
 
+## 修改收款人信息接口
+
+**简要描述:** 修改收款人信息,该接口为覆盖更新,故未变更的字段也需要传入,否则会置空
+
+**请求 URL:** `/payee/update`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 60次/分钟
+
+**请求参数:**
+
+请参考:[收款人](#收款人)
+
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
 
 # 财务类接口
 
@@ -341,6 +458,7 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 |**driverPhone**  <br>*必填*|司机电话  <br>**长度** : `1 - 18`|string|
 |**payFreight**  <br>*必填*|支付金额  <br>**最小值** : `0`  <br>**最大值** : `999999`|number (double)|
 |**payType**  <br>*必填*|支付方式,1:油卡,2:现金,3:支付宝,4:微信,5:银行转账,6:其它|integer (int32)|
+|**payee**  <br>*运单有关联收款人时可选*|收款人,默认用运单司机关联的收款人,如果受理单没有关联收款人,这里必填|[收款人](#收款人)|
 |**tradeNo**  <br>*必填*|资金流水号  <br>**长度** : `1 - 50`|string|
 |**note**  <br>*可选*|付款备注  <br>**长度** : `0 - 256`|string|
 
@@ -362,29 +480,24 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 }
 ```
 
-## 支付并核销接口
 
-**简要描述:** 支付并核销
+## 撤销核销接口
 
-**请求 URL:** `/writeoff/pay_and_writeoff`
+**简要描述:** 撤销核销
+
+**请求 URL:** `/writeoff/cancel`
 
 **请求方式:** POST
 
 **需要AccessToken:** 是
 
-**调用限制:** 60次/分钟
+**调用限制:** 120次/分钟
 
 **请求参数:**
 
 |名称|说明|类型|
 |---|---|---|
-|**carNumber**  <br>*必填*|车牌号码  <br>**长度** : `1 - 35`|string|
-|**customerOrderNumbers**  <br>*必填*|结算受理单列表|< string > array|
-|**driverName**  <br>*必填*|司机名称  <br>**长度** : `1 - 30`|string|
-|**driverPhone**  <br>*必填*|司机电话  <br>**长度** : `1 - 18`|string|
-|**payFreight**  <br>*必填*|支付金额  <br>**最小值** : `0`  <br>**最大值** : `999999`|number (double)|
-|**payType**  <br>*必填*|支付方式,1:油卡,2:现金,3:支付宝,4:微信,5:银行转账,6:其它|integer (int32)|
-|**note**  <br>*可选*|付款备注  <br>**长度** : `0 - 256`|string|
+|**customerOrderNumbers**  <br>*必填*|结算受理单列表  <br>**样例** : `[ "XXX", "XXX" ]`|< string > array|
 
 - 调用成功示例