11. 设备中台API
API列表
| 编号 | API名称 | 路径 | 版本 |
|---|---|---|---|
| 11.1 | 设备信息列表 | /mid/equipment/query/list | 1.0 |
| 11.2 | 设备模板列表 | /mid/equipment/template/query/list | 1.0 |
| 11.3 | 获取门禁授权楼栋信息 | /mid/equipment/door/getBuildIdByDoorId | 1.0 |
API调用
11.1: 获取设备列表
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/mid/equipment/query/list
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| typeCode | BODY | STRING | 否 | 设备类型 |
| equipmentId | BODY | STRING | 是 | 设备模板ID |
| projectId | BODY | STRING | 是 | 项目ID |
请求Body描述(非Form表单数据)
{
"typeCode": "",
"equipmentId": "1731",
"projectId": ""
"pageNo": 1,
"pageSize": 10
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| typeCode | data | STRING | 是 | 产品枚举 |
| macAddr | data | STRING | 是 | MAC地址 |
| equipmentName | data | STRING | 是 | 设备名称 |
| sn | data | STRING | 是 | 序列号SN |
| installAddr | data | STRING | 是 | 安装位置 |
| detailAddr | data | STRING | 是 | 详细位置 |
| projectId | data | STRING | 是 | 项目id |
| equipmentType | data | STRING | 是 | 设备型号 |
| equipmentBrand | data | STRING | 是 | 设备品牌 |
| equipmentSupplier | data | STRING | 是 | 设备供应商 |
| maintenanceUnit | data | STRING | 是 | 设备维保单位 |
| maintenancePerson | data | STRING | 是 | 维保联系人 |
| maintenancePhone | data | STRING | 是 | 维保联系电话 |
| equipmentManger | data | STRING | 是 | 设备负责人 |
| scrapDate | data | STRING | 是 | 设备报废日期 |
| equipmentCode | data | STRING | 是 | 设备编码 |
| productDate | data | STRING | 是 | 出厂日期 |
| equipmentInstId | data | STRING | 是 | 四格设备id |
| flag | data | STRING | 是 | 门禁：0大门门禁，1楼栋门禁 |
| doorType | data | STRING | 是 | 开门方式：1普通门，2蓝牙门，3二维码门 |
| auths | data | ARRAY | 否 | 门禁授权楼栋列表 |
| buildId | auths | STRING | 是 | 楼栋ID |
| startTime | auths | STRING | 是 | 开始时间 |
| endTime | auths | STRING | 是 | 结束时间 |
| status | auths | STRING | 是 | 状态：1有效，0无效 |
| userTypes | auths | ARRAY | 是 | 授权用户类型:业主、业主成员、租户、租户成员、员工、访客 |
返回结果示例
{
"equipments": [
{
"maintenancePerson": "",
"equipmentSupplier": "",
"equipmentManger": "",
"equipmentCode": "",
"maintenanceUnit": "",
"productDate": "",
"equipmentType": "普通门",
"maintenancePhone": "",
"detailAddr": "",
"installAddr": "",
"scrapDate": "",
"equipmentName": "大门-领贤74D",
"sn": "0000074D|01",
"projectId": "21441118",
"equipmentInstId": "141003",
"macAddr": "21441118_0000074D_01",
"equipmentBrand": "拓桥",
"flag": 1
"doorType": 1
"auths": [
{
"buildId": 1,
"startTime": "",
"endTime": "",
"status": ""
"userTypes": ["业主", "业主成员"]
}
]
}
],
"total": 3,
"pages": 1,
"pageNo": 1,
"pageSize": 500
}
11.2: 获取设备模板列表
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/mid/equipment/template/query/list
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
请求Body描述(非Form表单数据)
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
| equipmentId | data | STRING | 是 | 四格设备模板id |
| equipmentName | data | STRING | 是 | 设备模板名称 |
| equipmentType | data | STRING | 是 | 设备模板类型 |
返回结果示例
{
"records": [
{
"equipmentId": 2288,
"innerEquipmentId": 1000,
"innerEquipmentName": null,
"equipmentName": "热水表",
"equipmentType": "A2",
"equipmentCode": "1000",
"organId": null,
"equipmentInnerCode": null,
"upEquipmentId": 6339,
"equipmentInstType": "0",
"threshold": null,
"equipmentTemplateId": 38,
"tempId": null,
"tempUpId": null,
"eid1": 1730,
"ename1": "仪表",
"eid2": 6339,
"ename2": "水表",
"fname2": null,
"fname3": null
}
],
"total": 172,
"size": 10,
"current": 1,
"orders": [],
"searchCount": true,
"pages": 18
}
11.3: 获取门禁授权楼栋信息
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/mid/equipment/door/getBuildIdByDoorId
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| doorId | BODY | STRING | 是 | 门禁ID |
| communityId | BODY | STRING | 是 | 所属项目ID |
请求Body描述(非Form表单数据)
{
"doorId": 322,
"communityId": 323
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
| flag | data | STRING | 是 | 门禁：0大门门禁，1楼栋门禁 |
| doorType | data | STRING | 是 | 开门方式：1普通门，2蓝牙门，3二维码门 |
| auths | data | ARRAY | 否 | 门禁授权楼栋列表 |
| buildId | auths | STRING | 是 | 楼栋ID |
| startTime | auths | STRING | 是 | 开始时间 |
| endTime | auths | STRING | 是 | 结束时间 |
| status | auths | STRING | 是 | 状态：1有效，0无效 |
| changeTime | auths | STRING | 是 | 数据最后更新时间 |
| userTypes | auths | ARRAY | 是 | 授权用户类型:业主、业主成员、租户、租户成员、员工、访客 |
返回结果示例
{
"code": 200,
"message": "success",
"data": {
"flag": 1
"doorType": 1
"auths": [
{
"buildId": 1,
"startTime": "",
"endTime": "",
"status": ""
"changeTime": "",
"userTypes": ["业主", "业主成员"]
}
]
}
}