场景信息接口
GVP平台提供场景信息相关的接口,场景控制是GVP平台的逻辑功能,通过场景控制可以同时实现多个目标的控制,就是同时控制多个灯光设备或空调设备等,由GVP平台自由编辑场景的控制目标实现。
1、获取所有场景按钮信息
请求接口示例,192.168.1.108是GVP服务端所在电脑的IP地址,请根据实际情况调整
http://192.168.1.108:8008/api/?HDLRequest=GetAllSceneList
请求方式:POST
接口地址:/api/?HDLRequest=GetAllSceneList
请求数据类型:application/json
响应数据类型:application/json
接口描述: 获取所有场景按钮信息的数据
Headers参数
Key | Value | 描述 |
---|---|---|
Authorization | Token值 | 登录成功时获取到的Token值,如果过期请重新登录 |
请求参数,无
请求示例,空,或任意数据,该接口忽略请求参数的校验
null,{}
响应参数:
字段 | 类型 | 描述 |
---|---|---|
ReplyCode | String | 响应码 |
ReplyMessage | String | 响应消息提示 |
ReplyDataType | Integer | 响应数据类型,可忽略 |
ReplyObject | Array<Object> | 响应数据,详细信息参考示例说明 |
响应成功示例:
{
"ReplyCode": "Success",
"ReplyMessage": "成功",
"ReplyDataType": 0,
"ReplyObject": [
{
"SceneGuid": "a160e51f-28d8-41d4-9132-1e82a891a04c", // 场景按钮的唯一GUID
"SceneName": "场景1", // 场景名称
"SceneType": 0, // 第三方平台忽略
"SceneControlStyle": 1, // 场景按钮类型: 0正向控制,1正反控制
"ZoneGuid": "4ed78e21-397b-4e13-ba68-8eabba45d8b3", // 场景按钮所在区域GUID
"ZoneName": "洗手间", // 场景按钮所在区域名称
"SceneZoneLeveName": "河东企业→天河办公室→一楼→洗手间" // 场景按钮所在区域层级信息
},
{
"SceneGuid": "cafe29f4-5bb8-4680-b1ed-ec3ae75f5fd0", // 场景按钮的唯一GUID
"SceneName": "场景2", // 场景名称
"SceneType": 0, // 第三方平台忽略
"SceneControlStyle": 1, // 场景按钮类型: 0正向控制,1正反控制
"ZoneGuid": "4ed78e21-397b-4e13-ba68-8eabba45d8b3", // 场景按钮所在区域GUID
"ZoneName": "洗手间", // 场景按钮所在区域名称
"SceneZoneLeveName": "河东企业→天河办公室→一楼→洗手间" // 场景按钮所在区域层级信息
}
],
"TotalRowCount": 0,
"AlarmCount": 0,
"PageCount": 0
}
2、控制场景信息
请求接口示例,192.168.1.108是GVP服务端所在电脑的IP地址,请根据实际情况调整
http://192.168.1.108:8008/api/?HDLRequest=ControlSceneButton
请求方式:POST
接口地址:/api/?HDLRequest=ControlSceneButton
请求数据类型:application/json
响应数据类型:application/json
接口描述: 控制场景按钮的接口,指定单个场景信息进行控制
Headers参数
Key | Value | 描述 |
---|---|---|
Authorization | Token值 | 登录成功时获取到的Token值,如果过期请重新登录 |
请求参数
字段 | 类型 | 是否必须 | 描述 |
---|---|---|---|
SceneGuid | String | true | 场景按钮唯一Guid,查询所有场景按钮信息时得到的,控制时必须带上 |
请求示例,但是最后要使用加密方法加密字符串才提交
{"SceneGuid":""}
响应参数:
字段 | 类型 | 描述 |
---|---|---|
ReplyCode | String | 响应码 |
ReplyMessage | String | 响应消息提示 |
ReplyDataType | Integer | 响应数据类型,可忽略 |
ReplyObject | Array | 响应数据,详细信息参考示例说明 |
响应成功示例:
{
"ReplyCode": "Success",
"ReplyMessage": "成功",
"ReplyDataType": 0,
"ReplyObject": {},
"TotalRowCount": 0,
"AlarmCount": 0,
"PageCount": 0
}