Scene information interface

The GVP platform provides interfaces related to scene information. Scene control is a logical function of the GVP platform. Through scene control, multiple objectives can be controlled simultaneously, such as multiple lighting devices or air conditioning devices. The GVP platform allows for free editing of scene control objectives.

1. Obtain information of all scene buttons

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=GetAllSceneList

Request method: POST

Interface Address: /api/?HDLRequest=GetAllSceneList

Request data type: application/json

Response data type: application/json

Interface Description: Obtain data on all scene button information

Headers parameter

Request parameters, none

Request example, empty, or any data. This interface ignores the verification of request parameters

null,{}

Response parameters:

Response success example:

{
    "ReplyCode": "Success",
    "ReplyMessage": "Success",
    "ReplyDataType": 0,
    "ReplyObject": [
        {
            "SceneGuid": "a160e51f-28d8-41d4-9132-1e82a891a04c", // Unique GUID for the scene button
            "SceneName": "Scene 1", // Scene name
            "SceneType": 0, // ignored by third-party platforms
            "SceneControlStyle": 1, // Scene button type: 0 for forward control, 1 for both forward and reverse control
            "ZoneGuid": "4ed78e21-397b-4e13-ba68-8eabba45d8b3", // GUID of the area where the scene button is located
            "ZoneName": "Bathroom", // Name of the area where the scene button is located
            "SceneZoneLevelName": "Hedong Enterprise → Tianhe Office → First Floor → Restroom" // Level information of the area where the scene button is located
        },
        {
            "SceneGuid": "cafe29f4-5bb8-4680-b1ed-ec3ae75f5fd0", // Unique GUID for the scene button
            "SceneName": "Scene 2", // Scene name
            "SceneType": 0, // ignored by third-party platforms
            "SceneControlStyle": 1, // Scene button type: 0 for forward control, 1 for both forward and reverse control
            "ZoneGuid": "4ed78e21-397b-4e13-ba68-8eabba45d8b3", // GUID of the area where the scene button is located
            "ZoneName": "Bathroom", // Name of the area where the scene button is located
            "SceneZoneLevelName": "Hedong Enterprise → Tianhe Office → First Floor → Restroom" // Level information of the area where the scene button is located
        }
    ],
    "TotalRowCount": 0,
    "AlarmCount": 0,
    "PageCount": 0
}

2. Control scenario 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=ControlSceneButton

Request method: POST

Interface address: /api/?HDLRequest=ControlSceneButton

Request data type: application/json

Response data type: application/json

Interface Description: This interface controls scene buttons and specifies individual scene information for control

Headers parameter

Request parameters

Request example, but the string must be encrypted using an encryption method before submission

{"SceneGuid":""}

Response parameters:

Response success example:

{
    "ReplyCode": "Success",
    "ReplyMessage": "Success",
    "ReplyDataType": 0,
    "ReplyObject": {},
    "TotalRowCount": 0,
    "AlarmCount": 0,
    "PageCount": 0
}