Przeglądaj źródła

添加新接口

gmw 5 lat temu
rodzic
commit
b3465973ca
1 zmienionych plików z 73 dodań i 8 usunięć
  1. 73 8
      README.md

+ 73 - 8
README.md

@@ -7,19 +7,14 @@
   - [添加设备接口](#添加设备接口)
   - [上传设备状态位置数据接口](#上传设备状态位置数据接口)
   - [移除设备接口](#移除设备接口)
+  - [通过车牌号获取绑定设备的轨迹数据](#通过车牌号获取绑定设备的轨迹数据)
 - [其他问题](#其他问题)
 
 ## 接口简介
 
-用于对接三方设备的GPS数据,目前GPS相关接口有:
+用于对接三方设备的GPS数据,也可以获取轨迹数据。传参方式如无特殊说明均为application/json格式。不支持将参数写进url中传递。小黑卡用户不需要使用此接口上传轨迹数据。
 
-- 添加设备接口
-- 上传设备状态位置数据接口
-- 移除设备接口
-
-传参方式如无特殊说明均为application/json格式。不支持将参数写进url中传递。小黑卡用户不需要此接口。
-
-## 对接流程
+## 轨迹数据对接流程
 
 **1.获取token**
 
@@ -174,6 +169,76 @@
 }
 ```
 
+### 通过车牌号获取绑定设备的轨迹数据
+
+**1.简要描述** :通过车牌号获取绑定设备的轨迹数据
+
+**2.请求URL** :`/gps/get_gps_data`
+
+**3.请求方式** :POST
+
+**4.请求参数** :
+
+| **参数名** | **必选** | **类型** | **说明** |
+| --- | --- | --- | --- |
+| `carNumber` | `是` | `String` | `设备号,必填,多个设备用英文','隔开` |
+| `startTime` | `否` | `Integer` | `开始时间,如果不指定结束时间则查询开始时间到当前时间的数据` |
+| `endTime` | `否` | `Integer` | `结束时间,如果传了结束时间必须传开始时间` |
+**注:如果不传时间则只查询最近的一个轨迹点,查询时间范围不能超过5小时**
+
+**5.返回示例** :
+
+- 调用成功示例:
+```java
+{
+    "code": 200,
+    "message": null,
+    "data": {
+        "苏B285942": //传参时的车牌号
+        [
+            {
+                "device": "浙A34421", //车牌号绑定的设备号
+                "gpsTime": 1547793092, //定位时间
+                "lng": 120.114997, //精度
+                "lat": 30.248416, //纬度
+                "province": "浙江", //省份
+                "city": "杭州", //城市名
+                "location": "地址地址地址地址",  //定位地址
+                "roadName": "地址地址地址地址", //街道名
+                "locateType": 1, //轨迹上报类型必填:(0:未知,1:GPS,2:基站定位,4:北斗定位,5:GPS 和北斗定位)
+                "speed": 0, //速度
+                "direction": null, //方向
+                "address": {
+                    "province": "浙江", //省
+                    "city": "杭州", //市
+                    "district": "地址地址地址地址", //区
+                    "detail": "地址地址地址地址" //详细地址
+                }, 
+                "runStatus": 1,  //设备运行状态必填(1:行驶,2:停止,3:离线)
+                "created": 1547793212, //轨迹信息创建时间
+            },
+            {
+                .........
+            }
+        ],
+        "浙A98727": [.....]
+    }
+}
+```
+
+- 调用失败示例:
+```java
+{
+    "message": "查询时间范围不得大于5小时",
+    "status": 500
+}
+
+{
+    "message": "车牌号XXXX未绑定设备",
+    "status": 500
+}
+```
+
 ## 其他问题
 
 **1.如何在系统中查看上传的轨迹**