通用开关接口
通用开关控制,是GVP平台的逻辑功能,并非指哪个具体的设备,GVP提供了通用开关的查询接口和控制接口,第三方平台请根据业务需求使用相关的接口。
1、获取单个或所有通用开关数据
请求接口示例,192.168.1.108是GVP服务端所在电脑的IP地址,请根据实际情况调整
http://192.168.1.108:8008/api/?HDLRequest=GetCommonSwitchStatus
请求方式:POST
接口地址:/api/?HDLRequest=GetCommonSwitchStatus
请求数据类型:application/json
响应数据类型:application/json
接口描述: 获取单个或所有通用开关的数据
Headers参数
Key | Value | 描述 |
---|---|---|
Authorization | Token值 | 登录成功时获取到的Token值,如果过期请重新登录 |
请求参数
字段 | 类型 | 是否必须 | 描述 |
---|---|---|---|
DeviceGuid | String | true | 通用开关控制的唯一GUID,值为“all”时获取所有通用开关的信息,否则只获取GUID指定的单个通用开关信息 |
请求示例,但是最后要使用加密方法加密字符串才提交
{"DeviceGuid":"all"}
响应参数:
字段 | 类型 | 描述 |
---|---|---|
ReplyCode | String | 响应码 |
ReplyMessage | String | 响应消息提示 |
ReplyDataType | Integer | 响应数据类型,可忽略 |
ReplyObject | Array<Object> | 响应数据,详细信息参考示例说明 |
响应示例:
{
"ReplyCode": "Success",
"ReplyMessage": "成功",
"ReplyDataType": 0,
"ReplyObject": [
{
"DeviceGuid": "464f6edd-bb72-437f-9b2f-567a60db8f3d", // 通用开关信息的唯一GUID
"DeviceName": "逻辑控制1", // 通用开关控制的名称
"DeviceType": 25600, // 功能类型: 25600通用开关控制
"DeviceOnlineState": 1, // 在线状态: 2故障,1在线
"CommonSwitchStatus": 1, // 通用开关状态: 0关闭,1打开
"RegionName": "河东企业→天河办公室→一楼→大会议室" // 通用开关控制所在的区域层级信息
},
{
"DeviceGuid": "b4e0fc9e-2754-4b9f-840f-a471eba1d4cc", // 通用开关信息的唯一GUID
"DeviceName": "逻辑控制2", // 通用开关控制的名称
"DeviceType": 25600, // 功能类型: 25600通用开关控制
"DeviceOnlineState": 1, // 在线状态: 2故障,1在线
"CommonSwitchStatus": 0, // 通用开关状态: 0关闭,1打开
"RegionName": "河东企业→天河办公室→一楼→大会议室" // 通用开关控制所在的区域层级信息
}
],
"TotalRowCount": 0,
"AlarmCount": 0,
"PageCount": 0
}
2、控制通用开关功能
请求接口示例,192.168.1.108是GVP服务端所在电脑的IP地址,请根据实际情况调整
http://192.168.1.108:8008/api/?HDLRequest=ControlCommonSwitch
请求方式:POST
接口地址:/api/?HDLRequest=ControlCommonSwitch
请求数据类型:application/json
响应数据类型:application/json
接口描述: 控制通用开关号的接口,指定单个通用开关功能点进行控制
Headers参数
Key | Value | 描述 |
---|---|---|
Authorization | Token值 | 登录成功时获取到的Token值,如果过期请重新登录 |
请求参数
字段 | 类型 | 是否必须 | 描述 |
---|---|---|---|
DeviceGuid | String | true | 通用开关号唯一Guid |
CommonSwitchStatus | int | true | 通用开关动作类型,0关闭,1打开 |
请求示例,但是最后要使用加密方法加密字符串才提交
{"DeviceGuid":"","CommonSwitchStatus":0}
响应参数:
字段 | 类型 | 描述 |
---|---|---|
ReplyCode | String | 响应码 |
ReplyMessage | String | 响应消息提示 |
ReplyDataType | Integer | 响应数据类型,可忽略 |
ReplyObject | Array | 响应数据,详细信息参考示例说明 |
响应成功示例:
{
"ReplyCode": "Success",
"ReplyMessage": "成功",
"ReplyDataType": 0,
"ReplyObject": {},
"TotalRowCount": 0,
"AlarmCount": 0,
"PageCount": 0
}