编辑: 雷昨昀 | 2016-04-09 |
2.6 目录
1 范围
4 2 术语、定义和缩略语.4 2.1 术语、定义.4 2.2 缩略语.4
3 协议概述.4
4 接口
4 4.1 用户.4 4.1.1 登录.4 4.1.2 获取用户信息.5 4.2 车辆.6 4.2.1 根据 IMEI 查询车辆信息.6 4.2.2 根据用户 id 查询车辆信息.7 4.3 位置.8 4.3.1 查询历史轨迹.8 4.3.2 根据车辆 id 获取车辆状态.9 4.4 电子围栏.10 4.4.1 根据车辆 id 查询.10 4.4.2 添加.11 4.4.3 修改.11 4.4.4 删除电子围栏.12 4.5 树结构.13 4.5.1 获取用户树结构.13 4.5.2 获取车辆分组结构.13 4.5.3 根据 IMEI 或者设备名称搜索车辆
14 4.6 搜索.15 4.6.1 根据设备名称或者 IMEI 搜索
15 4.7 车辆告警触发开关.16 4.7.1 根据车辆 id 查询告警开关.16 4.7.2 添加或者更新开关.17 4.8 用户车辆告警消息.17 4.8.1 查询用户告警.17 4.8.2 根据车辆 id 查询.18 4.8.3 报警详情.19
5 附件
20 5.1 数据定义.20 5.1.1 用户类型.20 5.1.2 经纬度类型.21 5.1.3 定位方式.21 5.1.4 车辆告警类型定义.21 5.1.5 设备类型定义.21 5.1.6 车辆图标定义.22 5.1.7 设备状态定义.22 5.1.8 车辆告警触发定义.23 5.2 数据字典.23 5.2.1 用户.23 5.2.2 车辆.23 5.2.3 位置.24 5.2.4 电子围栏.24 5.2.5 树结构用户数据.25 5.2.6 车辆树数据.25 5.2.7 车辆最后状态数据.25 5.2.8 车辆告警开关.26 5.2.9 用户车辆告警开关.26 5.2.10 车辆告警.26 5.2.11 Acc 详情.26 5.3 代码定义.26 5.3.1 平台错误代码.26
1 范围 本文档规定了 Web 服务器对外接口. 本文档适用于网页,移动客户端的开发研制工作.
2 术语、定义和缩略语 2.1 术语、定义 2.2 缩略语 本文件应用了以下缩略语: 缩略语 英语全称 中文全称 HTTP hypertext transport protocol 超文本传送协议 JSON JavaScript Object Notation JavaScript 对象注解
3 协议概述 此通信接口基于 HTTP1.1 + JSON 协议进行开发. 默认所有非登录请求中附上 token
4 接口 4.1 用户 4.1.1 登录 类型 值 描述 URL String user/login.do 请求参数 name String 必填 登录名 password String 必填 登录密码 timeZoneSe cond Integer 选填 相对 UTC 时间毫秒数 (默认东八区 8x3600) lang String 选填 国家语言代码(默认简体中 文) zh_CN zh_HK zh_HK 响应参数 JSON {ret:1||0, data:用户数据} Exception 无 例句:http://www.gpsnow.net/user/login.do?name=test02&
password=123456 响应 json 演示: { data : { address : , email : , joinTime : 2018-10-19 14:02:09 , lang : zh_CN , linkMan : , linkPhone : , name : 真实设备测试
2 , parentId : 1, password : E10ADC3949BA59ABBE56E057F20F883E , rechargeURL : , remark : , subAlarm : true, timeZoneSecond : 28800, token : ce4c90eb-5285-47ac-93d3-1f5ad8718bad , updateTime : 2018-10-19 14:02:09 , userId : 1324, userName : test02 , userType :
1 }, ret :
1 } 4.1.2 获取用户信息 类型 值 描述 URL String user/getByUserId.do 请求参数 token String 必填 token userId Long 选填 用户 id 响应参数 JSON {ret:1||0, data:用户数据} Exception 无 例句: http://www.gpsnow.net/user/getByUserId.do?token=ce4c90eb-5285-47ac-93d3-1f5ad8718bad&
us erId=1324 响应 json 演示: { data : { address : , allCount : 41, email : , joinTime : 2018-10-19 14:02:09 , linkMan : , linkPhone : , name : 真实设备测试
2 , parentId : 1, password : E10ADC3949BA59ABBE56E057F20F883E , rechargeURL : , remark : , subAlarm : true, underCount : 16, updateTime : 2018-10-19 14:02:09 , userId : 1324, userName : test02 , userType :