Browse Source

修改错别字;

kuaihuoyun_ctms 4 years ago
parent
commit
ba67763da2
1 changed files with 77 additions and 9 deletions
  1. 77 9
      README.md

+ 77 - 9
README.md

@@ -16,7 +16,7 @@
     - [签收运单接口](#%E7%AD%BE%E6%94%B6%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
     - [查询运单接口](#%E6%9F%A5%E8%AF%A2%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
     - [撤销运单接口](#%E6%92%A4%E9%94%80%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3)
-    - [创建撮合运单接口](#创建撮合运单接口)
+    - [创建撮合运单接口](#%E5%88%9B%E5%BB%BA%E6%92%AE%E5%90%88%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)
@@ -36,8 +36,11 @@
     - [创建委托代收合同接口](#%E5%88%9B%E5%BB%BA%E5%A7%94%E6%89%98%E4%BB%A3%E6%94%B6%E5%90%88%E5%90%8C%E6%8E%A5%E5%8F%A3)
 - [实名认证类接口](#%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E7%B1%BB%E6%8E%A5%E5%8F%A3)
     - [实名认证接口](#%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E6%8E%A5%E5%8F%A3)
+- [位置信息类接口](#%E4%BD%8D%E7%BD%AE%E4%BF%A1%E6%81%AF%E7%B1%BB%E6%8E%A5%E5%8F%A3)
+    - [上报运单轨迹接口](#%E4%B8%8A%E6%8A%A5%E8%BF%90%E5%8D%95%E8%BD%A8%E8%BF%B9%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)
+    - [撮合运单](#%E6%92%AE%E5%90%88%E8%BF%90%E5%8D%95)
     - [货物](#%E8%B4%A7%E7%89%A9)
     - [承运人](#%E6%89%BF%E8%BF%90%E4%BA%BA)
     - [受理单收款人](#%E5%8F%97%E7%90%86%E5%8D%95%E6%94%B6%E6%AC%BE%E4%BA%BA)
@@ -47,6 +50,7 @@
     - [车辆](#%E8%BD%A6%E8%BE%86)
     - [收款人](#%E6%94%B6%E6%AC%BE%E4%BA%BA)
     - [经纪人](#%E7%BB%8F%E7%BA%AA%E4%BA%BA)
+    - [位置信息](#%E4%BD%8D%E7%BD%AE%E4%BF%A1%E6%81%AF)
 
 <!-- /TOC -->
 
@@ -326,7 +330,7 @@ https://wlhy.ali.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c
 |**page**  <br>*必填*|当前页  <br>**最小值** : `1`  <br>**最大值** : `1000`|string|
 |**size**  <br>*必填*|单页数量  <br>**最小值** : `1`  <br>**最大值** : `50`|string|
 |**orderNumbers**  <br>*可选*|运单号列表,一次最多50单  <br>**长度** : `1 - 50`|< string > array|
-|**timeType**  <br>*可选*|时间类型  <br>**值** : `created(创建时间),opened(开单时间),signed(完成时间),arrivedTime(到达时间),appointArriveTime(预约送达时间)`|string|
+|**timeType**  <br>*可选*|时间类型  <br>**可选值** : `created(创建时间),opened(开单时间),signed(完成时间),arrivedTime(到达时间),appointArriveTime(预约送达时间)`|string|
 |**beginDate**  <br>*可选*|开始时间 <br>**格式** : `yyyy-MM-dd HH:mm:ss`|string|
 |**endDate**  <br>*可选*|结束时间 <br>**格式** : `yyyy-MM-dd HH:mm:ss`|string|
 |**originalOrderNumber**  <br>*可选*|客户单号,支持模糊搜索|string|
@@ -421,7 +425,7 @@ https://wlhy.ali.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c
 |名称|说明|类型|
 |---|---|---|
 |**orderMatchUpList**  <br>*必填*|撮合运单列表,单次最多50个  <br>**长度** : `1 - 50`|< [撮合运单](#撮合运单) > array|
-|**organizationName**  <br>*可选*|组织机构名称,会创建至对应组织机构下,默认创建到总部|string|
+|**organizationName**  <br>*必填*|组织机构名称,会创建至对应组织机构下|string|
 
 **返回示例**
 
@@ -633,7 +637,7 @@ https://wlhy.ali.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c
 
 ## 修改收款人信息接口
 
-**简要描述:** 修改收款人信息,根据唯一标识更新对应收款人的信息,该接口为覆盖更新,故未变更的字段也需要传入,否则会置空
+**简要描述:** 修改收款人信息,根据唯一标识更新对应收款人的信息
 
 **请求 URL:** `/payee/update`
 
@@ -645,8 +649,12 @@ https://wlhy.ali.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c
 
 **请求参数:**
 
-请参考:[收款人](#收款人)
-
+|名称|说明|类型|
+|---|---|---|
+|**bankCardNumber**  <br>*必填*|银行卡号,该字段为收款人的唯一标识|string|
+|**bankName**  <br>*可选*|开户银行,支持的银行请参考[《部网络货运信息交互系统代码集》](https://fanyun-wlhy.oss-cn-hangzhou.aliyuncs.com/resources/部网络货运信息交互系统代码集.pdf)|string|
+|**phoneNumber**  <br>*可选*|手机号,不填则置空  <br>**长度** : `11`|string|
+|**note**  <br>*可选*|备注,不填则置空  <br>**长度** : `1 - 200`|string|
 
 - 调用成功示例
 
@@ -1098,6 +1106,47 @@ https://wlhy.ali.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c
 }
 ```
 
+
+# 位置信息类接口
+
+## 上报运单轨迹接口
+
+**简要描述:** 上报运单轨迹接口,位置信息必须是在上报运单的运输时间范围内的,否则会被拒绝。上报后如果无法看到轨迹,先确认运单绑定的设备是否在智能管车中绑定了小黑卡,若已绑定小黑卡则将使用小黑卡的轨迹数据。
+
+**请求 URL:** `/gps/report_gps_data_for_order`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 120次/分钟
+
+**请求参数:**
+
+|名称|说明|类型|
+|---|---|---|
+|**orderNumber**  <br>*必填*|运单号|string|
+|**gpsDataList**  <br>*必填*|位置信息列表,如果定位点较多,超过了单次请求的数量限制,则多次调用,分批上报  <br>**长度** : `1 - 500`|< [位置信息](#位置信息) > array|
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
 # 接口参数说明
 
 ## 运单
@@ -1106,7 +1155,7 @@ https://wlhy.ali.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c
 |---|---|---|
 |**orderNumber**  <br>*更新运单时必填*|运单号,更新运单时必填,创建运单时不需要填写|string|
 |**originalOrderNumber**  <br>*必填*|客户单号  <br>**长度** : `1 - 50`|string|
-|**businessType**  <br>*必填*|业务类型|enum (干线普货运输, 城市配送, 农村配送, 集装箱运输, 其他)|
+|**businessType**  <br>*必填*|业务类型  <br>**可选值** : `干线普货运输, 城市配送, 农村配送, 集装箱运输, 其他`|string|
 |**consignerName**  <br>*必填*|发货人姓名  <br>**长度** : `1 - 45`|string|
 |**consignerPhone**  <br>*必填*|发货人电话  <br>**长度** : `1 - 20`|string|
 |**consignerAddress**  <br>*必填*|发货人地址|[地址](#地址)|
@@ -1144,14 +1193,14 @@ https://wlhy.ali.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c
 |**settlementName**  <br>*可选*|结算方名称  <br>**长度** : `0 - 50`|string|
 |**settlementPhone**  <br>*可选*|结算方电话  <br>**长度** : `0 - 20`|string|
 |**shipperPay**  <br>*可选*|上游运费  <br>**最小值** : `0`  <br>**最大值** : `9999999`|number (double)|
-|**shipperPayType**  <br>*可选*|上游运费支付方式. 1:现付;2:到付;3:回付;4:周结;5:月结;6:货款扣;7:季度结;8:在线支付;9:到付月结|integer (int32)|
+|**shipperPayType**  <br>*可选*|上游运费支付方式  <br>**可选值** : 1:现付;2:到付;3:回付;4:周结;5:月结;6:货款扣;7:季度结;8:在线支付;9:到付月结|integer (int32)|
 |**startAddress**  <br>*可选*|起始地  <br>**长度** : `0 - 20`|string|
 
 ## 撮合运单
 |名称|说明|类型|
 |---|---|---|
 |**originalOrderNumber**  <br>*必填*|客户单号  <br>**长度** : `1 - 50`|string|
-|**businessType**  <br>*必填*|业务类型|enum (干线普货运输, 城市配送, 农村配送, 集装箱运输, 其他)|
+|**businessType**  <br>*必填*|业务类型  <br>**可选值** : `干线普货运输, 城市配送, 农村配送, 集装箱运输, 其他`|string|
 |**consignerName**  <br>*必填*|发货人姓名  <br>**长度** : `1 - 45`|string|
 |**consignerPhone**  <br>*必填*|发货人电话  <br>**长度** : `1 - 20`|string|
 |**consignerAddress**  <br>*必填*|发货人地址|[地址](#地址)|
@@ -1321,3 +1370,22 @@ https://wlhy.ali.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c
 |**idCard**  <br>*必填*|身份证号|string|
 |**idCardAddress**  <br>*可选*|身份证地址|string|
 |**remark**  <br>*可选*|备注  <br>**长度** : `1 - 200`|string|
+
+## 位置信息
+
+|名称|说明|类型|
+|---|---|---|
+|**longitude**  <br>*必填*|经度|number (double)|
+|**latitude**  <br>*必填*|纬度|number (double)|
+|**locateTime**  <br>*必填*|定位时间(时间戳,精确到秒),定位时间必须在设备运输时间范围内(开单时间和签收时间之间,未签收时为开单时间到开单时间往后45天之间)|integer (int32)|
+|**locateType**  <br>*必填*|定位类型:(0:未知,1:GPS,2:基站定位,4:北斗定位,5:GPS 和北斗定位)|integer (int32)|
+|**runStatus**  <br>*必填*|设备运行状态(1:行驶,2:停止,3:离线)|integer (int32)|
+|**addr**  <br>*可选*|设备完整定位地址,包含省市区  <br>**例** : `浙江省杭州市西湖区计量大厦`|string|
+|**province**  <br>*可选*|定位省份|string|
+|**city**  <br>*可选*|定位城市|string|
+|**roadName**  <br>*可选*|定位街道|string|
+|**speed**  <br>*可选*|设备速度(单位:km/h)|number (double)|
+|**direction**  <br>*可选*|设备运动方向(单位:角度)|number (double)|
+|**temperature**  <br>*可选*|设备温度(单位:度)|number (double)|
+|**humidity**  <br>*可选*|设备湿度(单位:度)|number (double)|
+|**powerRate**  <br>*可选*|设备电量(单位:%)|integer (int32)|