鸿升OBOS操作手册
终端数据查询接口

服务地址：http://obos.hopechart.com/api/v1.0

头部信息：发起API调用时需在Http请求头填写如下参数

  • Content-Type application/x-www-form-urlencoded; charset=UTF-8
  • systemCode 系统编码 - 联系管理员申请
  • x-auth-token 授权码 - 联系管理员申请

示例代码如下：

headers.put("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
headers.put("systemCode", "系统编码");
headers.put("x-auth-token", "授权码");
1
2
3

# 1.注册信息

# 1.1. 接口功能

通过远程接口调用，查询OBOS设备注册信息。

# 1.2. URL

/record/register

# 1.3. 请求方式

GET

# 1.4. 请求参数

参数名称 参数类型 是否必选 参数说明
terminalId Integer N 十位终端号
terminalId7 String N 七位终端号
dataTimeStart Long N 数据开始时间 UTC秒数
dataTimeEnd Long N 数据结束时间 UTC秒数

# 1.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200, 失败：非200值）
message String 消息信息
data Object 数据（结构如下）
    |--total Integer 符合条件的记录数
    |--rows Array 数据集
      |--terminalId Integer 十位终端号
      |--terminalId7 String 七位终端号
      |--province String 省域ID
      |--city String 市域ID
      |--factory String 制造商ID
      |--devType String 终端型号
      |--plateColor String 车牌颜色
      |--plateNumber String 车牌号码
      |--dataTime Long 数据时间 UTC秒数

# 1.6. 示例

# 1.6.1 请求示例

http://obosapi.hopechart.com/api/v1.0/record/register

{
  "terminalId": "3572875388",
  "terminalid7": "",
  "plateNumber": "",
  "dataTimeStart": "",
  "dataTimeEnd": ""
}
1
2
3
4
5
6
7

# 1.6.2 返回示例

{
  "code": 200,
  "data": {
    "rows": [
      {
        "city": 100,
        "dataTime": 1622105530,
        "dataTimeStr": "2021-05-27 16:52:10",
        "devType": "12345",
        "factory": "70211",
        "firstTime": null,
        "plateColor": 2,
        "plateNumber": "陕AB5H10",
        "province": 34,
        "terminalId": "3572875388",
        "terminalId7": "25Q8258"
      }
    ],
    "total": 1
  },
  "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# 2.联网信息

# 2.1. 接口功能

通过远程接口调用，查询OBOS设备联网信息。

# 2.2. URL

/record/network

# 2.3. 请求方式

GET

# 2.4. 请求参数

参数名称 参数类型 是否必选 参数说明
terminalId Integer N 十位终端号
logInOut Integer N 登录登出（0：登出；1：登录）
gate String N 网关地址
dataTimeStart Long N 数据开始时间 UTC秒数
dataTimeEnd Long N 数据结束时间 UTC秒数

# 2.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200, 失败：非200值）
message String 消息信息
data Object 数据（结构如下）
    |--total Integer 符合条件的记录数
    |--rows Array 数据集
      |--terminalId Integer 十位终端号
      |--logInOut Integer 登录登出（0：登出；1：登录）
      |--gate String 网关地址
      |--dataTime Long 数据时间 UTC秒数

# 2.6. 示例

# 2.6.1 请求示例

http://obosapi.hopechart.com/api/v1.0/record/network

{
  "terminalId": "3572875388",
  "logInOut": 1,
  "plateNumber": "",
  "dataTimeStart": "",
  "dataTimeEnd": ""
}
1
2
3
4
5
6
7

# 2.6.2 返回示例

{
  "code": 200,
  "data": {
    "rows": [
      {
        "dataTime": 1623141714,
        "dataTimeStr": "2021-06-08 16:41:54",
        "firstTime": null,
        "gate": "10.168.4.205",
        "logInOut": 1,
        "terminalId": "2005142085"
      }
    ],
    "total": 1
  },
  "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 3.参数信息

# 3.1. 接口功能

通过远程接口调用，查询OBOS设备历史参数信息。

# 3.2. URL

/record/param

# 3.3. 请求方式

GET

# 3.4. 请求参数

参数名称 参数类型 是否必选 参数说明
terminalId Integer N 十位终端号
paramId String N 参数ID，多个以英文逗号分隔
dataTimeStart Long N 数据开始时间 UTC秒数
dataTimeEnd Long N 数据结束时间 UTC秒数

# 3.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200, 失败：非200值）
message String 消息信息
data Object 数据（结构如下）
    |--total Integer 符合条件的记录数
    |--rows Array 数据集
      |--terminalId Integer 十位终端号
      |--paramId Integer 参数ID
      |--paramValue String 参数值
      |--dataTime Long 数据时间 UTC秒数

# 3.6. 示例

# 3.6.1 请求示例

http://obosapi.hopechart.com/api/v1.0/record/param

{
  "terminalId": "2103050229",
  "paramId": "0x0000005A",
  "dataTimeStart": "",
  "dataTimeEnd": ""
}
1
2
3
4
5
6

# 3.6.2. 返回示例

{
  "code": 200,
  "data": {
    "rows": [
      {
        "dataTime": 1620986459,
        "dataTimeEnd": null,
        "dataTimeStart": null,
        "dataTimeStr": "2021-05-14 18:00:59",
        "firstTime": 1620986459,
        "id": 581,
        "md5": "",
        "pageNum": 1,
        "pageSize": 20,
        "paramId": "0x0000005A",
        "paramIds": "",
        "paramValue": "3600",
        "terminalId": "2103050229"
      }
    ],
    "total": 1
  },
  "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# 4.位置信息

# 4.1. 接口功能

通过远程接口调用，查询OBOS设备位置信息。

# 4.2. URL

/record/gps

# 4.3. 请求方式

GET

# 4.4. 请求参数

参数名称 参数类型 是否必选 参数说明
terminalId Integer N 十位终端号
dataTimeStart Long N 数据开始时间 UTC秒数
dataTimeEnd Long N 数据结束时间 UTC秒数

# 4.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200, 失败：非200值）
message String 消息信息
data Object 数据（结构如下）
    |--total Integer 符合条件的记录数
    |--rows Array 数据集
      |--terminalId Integer 十位终端号
      |--warning String 报警标识
      |--state Integer GPS状态
      |--longitude Double 经度
      |--latitude Double 纬度
      |--height Double 海拔（米）
      |--gpsDSpeed Double 速度（km/h）
      |--sDir String 方向
      |--extraInfo String 扩展信息
      |--dataTime Long 数据时间 UTC秒数

# 4.6. 示例

# 4.6.1 请求示例

http://obosapi.hopechart.com/api/v1.0/record/gps

{
  "terminalId": "1201052770",
  "dataTimeStart": "",
  "dataTimeEnd": ""
}
1
2
3
4
5

# 4.6.2 返回示例

{
  "code": 200,
  "data": {
    "rows": [
      {
        "dataTime": 1623039022,
        "dataTimeStr": "2021-06-07 12:10:22",
        "dir": 0,
        "extraInfo": "",
        "firstTime": null,
        "gpsDSpeed": 0.0,
        "gpsSpeed": 0,
        "height": 50.0,
        "lat": 3.0314628E7,
        "latitude": 30.31,
        "lng": 1.20058181E8,
        "longitude": 120.06,
        "recvTime": 1623039024,
        "sDir": "正北",
        "state": 3,
        "terminalId": "2005142085",
        "warning": null
      }
    ],
    "total": 1
  },
  "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# 5.报文信息

# 5.1. 接口功能

通过远程接口调用，查询OBOS设备上下行报文信息。

# 5.2. URL

/record/updownlog

# 5.3. 请求方式

GET

# 5.4. 请求参数

参数名称 参数类型 是否必选 参数说明
terminalId Integer N 十位终端号
linkType Integer N 链路类型 1：上行 2：下行
originalPackage String N 原始报文
dataTimeStart Long N 数据开始时间 UTC秒数
dataTimeEnd Long N 数据结束时间 UTC秒数

# 5.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200, 失败：非200值）
message String 消息信息
data Object 数据（结构如下）
    |--total Integer 符合条件的记录数
    |--rows Array 数据集
      |--terminalId Integer 十位终端号
      |--packageNo Integer 报文编号
      |--gatewayIp String 网关IP
      |--linkType Integer 链路类型
      |--originalPackage String 原始报文
      |--dataTime Long 数据时间 UTC秒数

# 5.6. 示例

# 5.6.1 请求示例

http://obosapi.hopechart.com/api/v1.0/record/updownlog

{
  "terminalId": "1201052770",
  "linkType": 2,
  "originalPackage": "",
  "dataTimeStart": "",
  "dataTimeEnd": ""
}
1
2
3
4
5
6
7

# 5.6.2 返回示例

{
  "code": 200,
  "data": {
    "rows": [
      {
        "dataTime": 1622107309,
        "dataTimeStr": "2021-05-27 17:21:49",
        "firstTime": 1622107309,
        "gatewayIp": "10.168.4.205",
        "linkType": 2,
        "originalPackage": "7E8001000501357287538800BACAE60002000A7E",
        "packageNo": 369,
        "terminalId": "3572875388"
      }
    ],
    "total": 752
  },
  "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# 6.称重传感数据

# 6.1. 接口功能

通过远程接口调用，查询OBOS设备称重传感数据信息。

# 6.2. URL

/record/weighing/sensor

# 6.3. 请求方式

GET

# 6.4. 请求参数

参数名称 参数类型 是否必选 参数说明
terminalId Integer N 十位终端号
idx Integer N 传感器序号
state Integer N 传感器状态
dataTimeStart Long N 数据开始时间 UTC秒数
dataTimeEnd Long N 数据结束时间 UTC秒数

# 6.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200, 失败：非200值）
message String 消息信息
data Object 数据（结构如下）
    |--total Integer 符合条件的记录数
    |--rows Array 数据集
      |--terminalId Integer 十位终端号
      |--idx Integer 传感器序号
      |--ad Long 传感器AD值
      |--state Integer 传感器状态
      |--dataTime Long 数据时间 UTC秒数

# 6.6. 示例

# 6.6.1 请求示例

http://obosapi.hopechart.com/api/v1.0/record/weighing/sensor

{
  "terminalId": "1201052770",
  "linkType": 2,
  "originalPackage": "",
  "dataTimeStart": "",
  "dataTimeEnd": ""
}
1
2
3
4
5
6
7

# 6.6.2 返回示例

{
  "code": 200,
  "data": {
    "rows": [
      {
        "ad": 166176512,
        "dataTime": 1623045116999,
        "dataTimeStr": "2021-06-07 13:51:56:999",
        "state": 0,
        "terminalId": "1910281129"
      }
    ],
    "total": 1
  },
  "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Last Updated: 6/30/2021, 7:12:57 PM