鸿升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

/cmd/param/setting

# 1.3. 请求方式

POST

# 1.4. 请求参数

参数名称 参数类型 是否必选 参数说明
terminalId String Y 10位终端号
paramId String Y 参数ID
paramType String Y 参数类型（WORD、BYTE_4、BCD、STRING、DWORD、BYTE、BYTE_8、BYTE_ARRAY、BIT）
value String Y 参数值

# 1.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200；失败：非200）
message String 消息

# 1.6. 请求示例

http://obos.hopechart.com/api/v1.0/cmd/param/setting

请求参数如下:

{
  "terminalId": "1910281048",
  "paramId": "0x0000E007",
  "paramType": "DWORD",
  "value": "23923"
}
1
2
3
4
5
6

# 2.参数设置(多设备)

# 2.1. 接口功能

通过远程接口调用，实现在OBOS平台多设备参数设置。

# 2.2. URL

/cmd/params/setting

# 2.3. 请求方式

POST

# 2.4. 请求参数

通过JSON数组方式传递多个参数对象，单个对象字段如下表描述：

参数名称 参数类型 是否必选 参数说明
terminalId String Y 10位终端号
paramId String Y 参数ID
paramType String Y 参数类型（WORD、BYTE_4、BCD、STRING、DWORD、BYTE、BYTE_8、BYTE_ARRAY、BIT）
value String Y 参数值

# 2.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200；失败：非200）
message String 消息

# 2.6. 请求示例

http://obos.hopechart.com/api/v1.0/cmd/params/setting

请求参数值如下：

[
  {
    "paramId": "0x0000E007",
    "paramType": "DWORD",
    "terminalId": "1910281048",
    "value": "1000"
  },
  {
    "paramId": "0x0001002C",
    "paramType": "DWORD",
    "terminalId": "1910281048",
    "value": "3000"
  },
  {
    "paramId": "0x0000005A",
    "paramType": "DWORD",
    "terminalId": "1910281048",
    "value": "500"
  },
  {
    "paramId": "0x00000058",
    "paramType": "DWORD",
    "terminalId": "1910281048",
    "value": "1000"
  }
]
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

# 3.参数查询(单设备)

# 3.1. 接口功能

通过远程接口调用，实现在OBOS平台单设备参数查询。

# 3.2. URL

/cmd/param/query

# 3.3. 请求方式

POST

# 3.4. 请求参数

参数名称 参数类型 是否必选 参数说明
terminalId String Y 10位终端号
paramId String Y 参数ID

# 3.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200；失败：非200）
message String 消息
data String 数据
{
    "code": 200,
    "data": {
        "2012112056": [
            {
                "上报时间": "2021-06-29 17:06:26",
                "参数名": "0x0000FE57",
                "参数值": "jc.bjmemc.com.cn"
            }
        ]
    },
    "message": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# 3.6. 请求示例

http://obos.hopechart.com/api/v1.0/cmd/param/query

{
  "terminalId": "2012112056",
  "paramId": "0x0000FE57"
}
1
2
3
4

# 4.参数查询(多设备)

# 4.1. 接口功能

通过远程接口调用，实现在OBOS平台多设备参数查询。

# 4.2. URL

/cmd/params/query

# 4.3. 请求方式

POST

# 4.4. 请求参数

通过JSON数组传递多个参数对象，单个参数字段如下：

参数名称 参数类型 是否必选 参数说明
terminalId String Y 10位终端号
paramId String Y 参数ID

# 4.5. 接口返回

参数名称 参数类型 参数说明
code Integer 接口状态码（成功：200；失败：非200）
message String 消息
data String 数据
{
    "code": 200,
    "data": {
        "2012112056": [
            {
                "上报时间": "2021-06-29 17:06:26",
                "参数名": "0x0000F064",
                "参数值": "AppVer: 7.5.9.cn"
            },
            {
                "上报时间": "2021-06-29 17:06:26",
                "参数名": "0x0000FE57",
                "参数值": "jc.bjmemc.com.cn"
            },
            {
                "上报时间": "2021-06-29 17:06:26",
                "参数名": "0x0000FE58",
                "参数值": "10.130.129.113"
            },
            {
                "上报时间": "2021-06-29 17:06:26",
                "参数名": "0x0000FE52",
                "参数值": "CMIOTFTZK"
            }
        ]
    },
    "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

# 4.6. 请求示例

http://obos.hopechart.com/api/v1.0/cmd/params/query

请求参数如下：

[
  {
    "paramId": "0x0000E007",
    "terminalId": "1910281048"
  },
  {
    "paramId": "0x0001002C",
    "terminalId": "1910281048"
  },
  {
    "paramId": "0x0000005A",
    "terminalId": "1910281048"
  },
  {
    "paramId": "0x00000058",
    "terminalId": "1910281048"
  }
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Last Updated: 7/30/2021, 3:51:49 PM