Device function point information interface
GVP provides an interface for unified querying of all device function point information, supports filtering conditions for querying device function point information, and third-party platforms extract relevant device function point information based on business requirements from the returned data;
Query all device function point information
Request interface example: 192.168.1.108 is the IP address of the computer where the GVP server is located. Please adjust according to the actual situation
http://192.168.1.108:8008/api/?HDLRequest=GetUIDeviceList
Method:POST
Address:/api/?HDLRequest=GetUIDeviceList
ContentType:application/json
Description
Interface for querying information on all device function points, supporting pagination queries
Headers
| Key | Value | Description |
|---|---|---|
| Authorization | Token | The Token value obtained upon successful login. If it expires, please log in again |
Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| PageSize | int | true | The number of items displayed on each page must be greater than 1, and the value must also be>=1 when querying without pagination |
| CurrentPage | int | true | The current displayed page numbers start from 0, where 0 is the first page and 1 is the second page .. |
| PageShow | String | true | Whether to paginate, true pagination display, false no pagination, return all row data |
| DeviceOnlineState | int | false | Device status values: 1 online, 2 faulty; Filter all states without setting this request parameter |
| DeviceFunctionType | int | false | Device function types: 1 switch, 2 lighting, 3 sunshade, 4 air conditioning, 10 universal switch; Filter all devices and do not set this request parameter |
| DeviceName | String | false | Device name filter; Filter all devices do not set this request parameter |
| ZoneGuid | String | false | Zone GUID value filter; Filter all zones do not set this request parameter |
Request Example
Paging query, first page, lighting equipment, online status, filtering function device data
But in the end, the string must be encrypted using encryption methods before submission
{
"PageSize":10,
"CurrentPage":0,
"PageShow":"true",
"DeviceOnlineState":1,
"DeviceFunctionType":2
}
Request example: query all functional device data without pagination, but finally encrypt the string using an encryption method before submission
{
"PageSize":1,
"CurrentPage":0,
"PageShow":"false"
}
Response parameters:
| Field | Type | Description |
|---|---|---|
| ReplyCode | String | Response code |
| ReplyMessage | String | Response message prompt |
| ReplyDataType | Integer | Response data type, can be ignored |
| ReplyObject | Array | Response data. For detailed information, refer to the example description |
Response example:
{
"ReplyCode": "Success",
"ReplyMessage": "Success",
"ReplyDataType": 0,
"ReplyObject": [
{
"DeviceGuid": "0c05b48f-6c1e-4a05-9960-5fcb20932852", // Unique GUID for device functionality
"DeviceName": "KNX-Lighting-1", // Name of the device function
"DeviceOnlineState": 1, // Device status: 2 - Faulty, 1 - Online
"DeviceType": 268, // Device secondary classification: 256 dimming lamp, 257 switch lamp, 258 color temperature lamp, 259 RGB lamp, 262 DALI dimmable lamp, 1281 motion detection, 1282 temperature, 1283 humidity, 1284 illumination, 1285 TVOC, 1286 PM2.5, 1287 CO2, 512 opening and closing curtain motor, 513 roller shutter, 514 ordinary curtain, 515 louver, 25600 universal switch
"DeviceBigClass": 1,
"ProtocolStyle": 1,
"TagGuid": "",
"DeviceControlClicks": 0,
"RemainDeviceControlClicks": 0,
"HaveDeviceControlClicks": 0,
"DeviceFunctionType": 2, // Device function type: 1 for switch, 2 for lighting, 3 for shading, 4 for air conditioning, 10 for universal switch;
"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": "Hedong Enterprise→ceshi", // Hierarchical structure information of the area where the device is located
"ZoneGuid": "16fee8e3-5034-431c-9852-3dd81286a727", // GUID of the zone information where the device is located
"ZoneListVirtualObject": [
{
"ZoneGuid": "16fee8e3-5034-431c-9852-3dd81286a727",
"ZoneName": "ceshi",
"ZoneLevelName": "Hedong Enterprise → ceshi",
"ViewReferenceState": 0
}
],
"PowerBoxName": "",
"ModuleVersionInfo": "",
"DeviceUpdateTime": "",
"ProjectGuid": "0",
"ProjectName": "Hedong Enterprise",
"ViewType": 6,
"EmptySwitchID": "",
"EmptySwitchStyle": "",
"Switch_OnOff": 0,
"Switch_Temperature": 0.0
}
],
"TotalRowCount": 33,
"AlarmCount": 0,
"PageCount": 4
}