Regional information interface
GVP provides a regional information query interface. The device function points of GVP must be displayed within a specific region. By querying, all regional information, including the hierarchical structure of regions, can be obtained. Third-party platforms can process the regional information based on business requirements.
Query all regional 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=ZoneListShow
Request method: POST
Interface address: /api/?HDLRequest=ZoneListShow
Request data type: application/json
Response data type: application/json
Interface Description: Obtain data on all regional information
Headers parameter
| Key | Value | Description |
|---|---|---|
| Authorization | Token Value | The Token value obtained upon successful login. If it has expired, please log in again |
Request parameters, none
Request example, empty, or any data. This interface ignores the verification of request parameters
null,{}
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 |
Example of successful response:
{
"ReplyCode": "Success",
"ReplyMessage": "Success",
"ReplyDataType": 0,
"ReplyObject": [
{
"ZoneGuid": "0d6ab5c5-3778-4bec-9d0b-f8e403ec7fdb", // Unique GUID for zone information
"ZoneName": "First Floor", // Name of the zone information
"ZoneLevel": "0.ec95ce37-6be8-4dc8-bb02-b989053b4665.a62fdf31-efaf-494d-89e6-c76d856f8d10", // Hierarchical structure of zone information, with 0 being the top level, separated by dots, excluding itself, and the last one being the GUID of the parent zone
"ZoneLevelName": "Hedong Enterprise → Tianhe Office → First Floor", // Hierarchical structure of zone information, separated by the symbol →
"ParentZoneGuid": "a62fdf31-efaf-494d-89e6-c76d856f8d10", // GUID of the parent zone of the current zone, GUID of the parent zone
"SeqNumber": 1,
"ZoneVisible": 0, // Whether the zone is visible: 0 for visible, 1 for invisible
"ZoneCreateTime": "2021-11-29T15:15:26",
"ZoneMoreMessage": "",
"ZoneSource": "0",
"ZoneLayout": 0,
"BackGroundShowType": 0,
"ZoneBackColor": "#ffffff",
"ZoneBmgIconUrl": "",
"ZoneBmgSize": "1750-810",
"AllTurnOn": 1,
"AllTurnOff": 1,
"ProjectGuid": "0"
},
{
"ZoneGuid": "16706ee3-9837-4582-b732-479a88d55db4", // Unique GUID for zone information
"ZoneName": "Real Estate Sales Department", // Name of the zone information
"ZoneLevel": "0.ec95ce37-6be8-4dc8-bb02-b989053b4665.a62fdf31-efaf-494d-89e6-c76d856f8d10.0d6ab5c5-3778-4bec-9d0b-f8e403ec7fdb", // Hierarchical structure of zone information, with 0 being the top level, separated by dots, excluding itself, and the last one being the parent zone GUID
"ZoneLevelName": "Hedong Enterprise → Tianhe Office → First Floor → Real Estate Sales Department", // Hierarchical structure of zone information, separated by the → symbol
"ParentZoneGuid": "0d6ab5c5-3778-4bec-9d0b-f8e403ec7fdb", // GUID of the parent zone of the current zone, the GUID of the parent zone
"SeqNumber": 6,
"ZoneVisible": 0, // Whether the zone is visible: 0 for visible, 1 for invisible
"ZoneCreateTime": "2022-02-18T10:31:14",
"ZoneMoreMessage": "",
"ZoneSource": "0",
"ZoneLayout": 0,
"BackGroundShowType": 0,
"ZoneBackColor": "#ffffff",
"ZoneBmgIconUrl": "",
"ZoneBmgSize": "1750-810",
"AllTurnOn": 1,
"AllTurnOff": 1,
"ProjectGuid": "0"
}
],
"TotalRowCount": 0,
"AlarmCount": 0,
"PageCount": 0
}