Browse Source

新增接口

gmw 4 years ago
parent
commit
4a5a19e0f8
1 changed files with 115 additions and 0 deletions
  1. 115 0
      README.md

+ 115 - 0
README.md

@@ -22,6 +22,9 @@
 - [财务类接口](#%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%92%A4%E9%94%80%E6%A0%B8%E9%94%80%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%E4%BC%A0%E8%AE%BE%E5%A4%87%E7%8A%B6%E6%80%81%E4%BD%8D%E7%BD%AE%E6%95%B0%E6%8D%AE%E6%8E%A5%E5%8F%A3)
+    - [批量上传设备状态位置数据接口](#%E6%89%B9%E9%87%8F%E4%B8%8A%E4%BC%A0%E8%AE%BE%E5%A4%87%E7%8A%B6%E6%80%81%E4%BD%8D%E7%BD%AE%E6%95%B0%E6%8D%AE%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)
@@ -31,6 +34,7 @@
     - [司机](#%E5%8F%B8%E6%9C%BA)
     - [车辆](#%E8%BD%A6%E8%BE%86)
     - [收款人](#%E6%94%B6%E6%AC%BE%E4%BA%BA)
+    - [位置信息](#%E4%BD%8D%E7%BD%AE%E4%BF%A1%E6%81%AF)
 
 <!-- /TOC -->
 
@@ -518,6 +522,83 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 ```
 
 
+# 位置信息类接口
+
+## 上传设备状态位置数据接口
+
+**简要描述:** 上传单个位置信息接口,如果一次性需要传多个位置信息,则推荐使用[批量上传接口](#批量上传设备状态位置数据接口)
+
+**请求 URL:** `/gps/push_gps_data`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 5000次/小时
+
+**请求参数:**
+
+请参考:[位置信息](#位置信息)
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+
+## 批量上传设备状态位置数据接口
+
+**简要描述:** 批量上传设备状态位置数据接口
+
+**请求 URL:** `/gps/batch_push_gps_data`
+
+**请求方式:** POST
+
+**需要AccessToken:** 是
+
+**调用限制:** 60次/分钟
+
+**请求参数:**
+
+请参考:
+|名称|说明|类型|
+|---|---|---|
+|**gpsDataList**  <br>*必填*|位置信息列表,单次最多1000个点、50台不同的设备|< [位置信息](#位置信息) > array|
+
+- 调用成功示例
+
+```java
+{
+    "code": 200,
+    "data": true,
+    "message": null
+}
+```
+
+- 调用失败示例
+
+```java
+{
+    "code": 500,
+    "message": "xxxxxxxx"
+}
+```
+
+
 # 接口参数说明
 
 ## 运单
@@ -676,3 +757,37 @@ https://wlhy.hw.56fanyun.com/order/create_order?access_token=fe12047e-52b1-418c-
 |**phoneNumber**  <br>*可选*|手机号  <br>**长度** : `11`|string|
 |**idCard**  <br>*可选*|身份证|string|
 |**note**  <br>*可选*|备注  <br>**长度** : `1 - 200`|string|
+
+## 位置信息
+
+|名称|说明|类型|
+|---|---|---|
+|**device**  <br>*必填*|设备号|string|
+|**longitude**  <br>*必填*|经度|number (double)|
+|**latitude**  <br>*必填*|纬度|number (double)|
+|**locateTime**  <br>*必填*|定位时间(时间戳,精确到秒)|integer (int32)|
+|**locateType**  <br>*必填*|定位类型:(0:未知,1:GPS,2:基站定位,4:北斗定位,5:GPS 和北斗定位)|integer (int32)|
+|**runStatus**  <br>*必填*|设备运行状态(1:行驶,2:停止,3:离线)|integer (int32)|
+|**addr**  <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)|
+|**abnormalInfo**  <br>*可选*|异常点内容:详细描述|string|
+|**abnormalProfile**  <br>*可选*|异常点类型:简述|string|
+|**note1**  <br>*可选*|自定义备注1|string|
+|**note2**  <br>*可选*|自定义备注2|string|
+|**note3**  <br>*可选*|自定义备注3|string|
+|**note4**  <br>*可选*|自定义备注4|string|
+|**note5**  <br>*可选*|自定义备注5|string|
+|**note6**  <br>*可选*|自定义备注6|string|
+|**note7**  <br>*可选*|自定义备注7|string|
+|**note8**  <br>*可选*|自定义备注8|string|
+|**note9**  <br>*可选*|自定义备注9|string|
+|**note10**  <br>*可选*|自定义备注10|string|
+|**note11**  <br>*可选*|自定义备注11|string|
+|**note12**  <br>*可选*|自定义备注12|string|