设备功能点信息接口
GVP提供统一查询所有设备功能点信息的接口,支持筛选条件查询设备功能点信息,第三方平台得到返回的数据根据业务需求提取相关设备功能点信息;
查询所有设备功能点信息
请求接口示例,192.168.1.108是GVP服务端所在电脑的IP地址,请根据实际情况调整
http://192.168.1.108:8008/api/?HDLRequest=GetUIDeviceList
请求方式:POST
接口地址:`/api/?HDLRequest=GetUIDeviceList
请求数据类型:application/json
响应数据类型:application/json
接口描述: 查询所有设备功能点信息的接口,支持分页查询
Headers参数
Key | Value | 描述 |
---|---|---|
Authorization | Token值 | 登录成功时获取到的Token值,如果过期请重新登录 |
请求参数
字段 | 类型 | 是否必须 | 描述 |
---|---|---|---|
PageSize | int | true | 每页显示的个数,必须大于1,不分页查询该值也必须>=1 |
CurrentPage | int | true | 当前显示页码,从0开始,0是第一页,1是第二页... |
PageShow | String | true | 是否分页,true分页显示,false不分页,返回所有行数据 |
DeviceOnlineState | int | false | 设备状态值:1在线,2故障;筛选所有状态不要设置该请求参数 |
DeviceFunctionType | int | false | 设备功能类型:1开关,2照明,3遮阳,4空调,10通用开关;筛选所有设备不要设置该请求参数 |
DeviceName | String | false | 设备名称过滤,;筛选所有设备不要设置该请求参数 |
ZoneGuid | String | false | 筛选区域GUID值;筛选所有区域不要设置该请求参数 |
请求示例,分页查询,第一页,照明设备,在线状态,筛选功能设备的数据,但是最后要使用加密方法加密字符串才提交
{
"PageSize":10,
"CurrentPage":0,
"PageShow":"true",
"DeviceOnlineState":1,
"DeviceFunctionType":2
}
请求示例,不分页,查询所有功能设备的数据,但是最后要使用加密方法加密字符串才提交
{
"PageSize":1,
"CurrentPage":0,
"PageShow":"false"
}
响应参数:
字段 | 类型 | 描述 |
---|---|---|
ReplyCode | String | 响应码 |
ReplyMessage | String | 响应消息提示 |
ReplyDataType | Integer | 响应数据类型,可忽略 |
ReplyObject | Array<Object> | 响应数据,详细信息参考示例说明 |
响应示例:
{
"ReplyCode": "Success",
"ReplyMessage": "成功",
"ReplyDataType": 0,
"ReplyObject": [
{
"DeviceGuid": "0c05b48f-6c1e-4a05-9960-5fcb20932852", // 设备功能唯一GUID
"DeviceName": "KNX-照明-1", // 设备功能的名称
"DeviceOnlineState": 1, // 设备状态: 2故障,1在线
"DeviceType": 268, // 设备二级分类: 256调光灯,257开关灯,258色温灯,259RGB灯,262DALI可调光灯,1281移动探测,1282温度,1283湿度,1284照度,1285TVOC,1286PM2.5,1287CO2,512开合帘电机,513卷帘,514普通窗帘,515百叶窗,25600通用开关
"DeviceBigClass": 1,
"ProtocolStyle": 1,
"TagGuid": "",
"DeviceControlClicks": 0,
"RemainDeviceControlClicks": 0,
"HaveDeviceControlClicks": 0,
"DeviceFunctionType": 2, // 设备功能类型:1开关,2照明,3遮阳,4空调,10通用开关;
"DeviceControlStyle": 1,
"DeviceParsList": [
1
],
"DeviceEnable": 0,
"DeviceHoursLife": 0,
"RemainDeviceHoursLife": 0,
"DeviceHoursLifeRun": 0,
"DevicePowerValue": 0.0,
"DeviceMoreMessage": "",
"ModuleGuid": "622b50d7-0db5-434b-8f75-a5a7540c02e5",
"ModuleName": "2/2/3",
"ModuleTypeChineseName": "",
"ModuleTypeEnglishName": "",
"Bus_SubnetID": 0,
"Bus_Channel": 0,
"ZonePositionName": "河东企业→ceshi", // 设备所在区域的层级结构信息
"ZoneGuid": "16fee8e3-5034-431c-9852-3dd81286a727", // 设备所在区域信息的GUID
"ZoneListVirtualObject": [
{
"ZoneGuid": "16fee8e3-5034-431c-9852-3dd81286a727",
"ZoneName": "ceshi",
"ZoneLevelName": "河东企业→ceshi",
"ViewReferenceState": 0
}
],
"PowerBoxName": "",
"ModuleVersionInfo": "",
"DeviceUpdateTime": "",
"ProjectGuid": "0",
"ProjectName": "河东企业",
"ViewType": 6,
"EmptySwitchID": "",
"EmptySwitchStyle": "",
"Switch_OnOff": 0,
"Switch_Temperature": 0.0
}
],
"TotalRowCount": 33,
"AlarmCount": 0,
"PageCount": 4
}