10. 设备房设备API
API列表
编号 | API名称 | 路径 | 版本 |
---|---|---|---|
1.1 | 设备房设备删除 | /v1/iot/eba/device/room/device/delete | 1.0 |
1.2 | 添加或编辑点位 | /v1/iot/eba/device/room/device/saveOrUpdatePoint | 1.0 |
1.3 | 删除设备点位 | /v1/iot/eba/device/room/device/deletePoint | 1.0 |
1.4 | 设备房设备分页 | /v1/iot/eba/device/room/device/page | 1.0 |
API调用
1.1: 设备房设备删除
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/eba/device/room/device/delete
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | body | int | Y | 主键id |
请求Body描述(非Form表单数据)
{
"ids":[
5,6
]
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
1.2: 添加或编辑点位
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/eba/device/room/device/saveOrUpdatePoint
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | body | int | Y | 主键id |
deviceX | body | int | Y | 设备点位X坐标 |
deviceY | body | int | Y | 设备点位Y坐标 |
请求Body描述(非Form表单数据)
{
"id": 9,
"deviceX": 100,
"deviceY": 100
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
1.3: 删除设备点位
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/eba/device/room/device/deletePoint
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | body | int | Y | 主键id |
请求Body描述(非Form表单数据)
{
"id": 1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
1.4: 设备房设备分页
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/iot/eba/device/room/device/page
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
pageSize | body | int | Y | 每页条数 |
pageNo | body | int | Y | 当前页数 |
deviceRoomId | body | int | Y | 设备房id |
deviceName | body | string | N | 设备名称 |
mac | body | string | N | mac地址 |
请求Body描述(非Form表单数据)
{
"pageNo": 1,
"pageSize": 2,
"deviceRoomId": 1,
"deviceName":"设备名称",
"mac": "abc"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | Y | 响应码标识 |
message | 顶层 | STRING | Y | 响应消息文本 |
data | 顶层 | JSONObject | Y | 响应数据对象 |
total | data | int | Y | 总条数 |
pageNo | data | int | Y | 总条数 |
pageSize | data | int | Y | 总条数 |
records | data | Array | Y | 列表 |
返回结果示例
{
"code": "200",
"success": true,
"data": {
"total": 8,
"pages": 4,
"records": [
{
"deviceMode": "ABS",
"online": "0",
"deviceX": 1,
"deviceY": 1,
"id": 4,
"deviceName": "测试设备",
"projectId": 2,
"deviceRoomId": 1,
"mac": "123456"
},
{
"deviceMode": "ABS",
"online": "0",
"deviceX": 1,
"deviceY": 1,
"id": 5,
"deviceName": "测试设备",
"projectId": 2,
"deviceRoomId": 1,
"mac": "123456"
}
]
}
}