获取周界预警参数
接口调用说明
请求地址 : /v1/api/device/alarm/get_ivp_rl_params
请求方式 : POST
请求头
| 参数名 | 参数值 | 是否必须 |
|---|---|---|
| Content-Type | application/json | 是 |
| X-Token | 实际accessToken | 是 |
请求报文体
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| deviceSn | String | 是 | 设备序列号 |
| channelId | int | 是 | 通道号 >=0 |
//示例数据
{
"deviceSn": "**********",
"channelId": 0
}
响应报文
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| code | int | 是 | 状态码 |
| msg | String | 是 | 状态码解释信息 |
| data | Object | 否 | 返回内容(详情见下表) |
data内容如下:
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| enable | boolean | 是 | true : 开启 false :关闭 |
| params | object | 是 | 周界预警参数 (详情见下表) |
| maxWidth | int | 是 | 设备支持的最大宽 |
| maxHeight | int | 是 | 周界预警参数 (详情见下表) |
| maxRegions | int | 是 | 周界预警参数 (详情见下表) |
| maxTimePeriods | int | 是 | 周界预警参数 (详情见下表) |
params内容如下:
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| sensitivity | int | 是 | 灵敏度，范围0～255 |
| alarmSoundEnable | boolean | 是 | 报警声音开关 |
| region | Object[] | 是 | 布防矩阵，矩阵个数不能大于 maxRegions (详情见下表) |
| time | Object | 布防时间设置 (详情见下表) |
region内容如下:
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| type | int | 是 | 0: 区域 1：线 |
| checkMode | int | 是 | 检测方向 0表示从左到右，1表示从右到左，2左右双向。如果线是水平的则使用方向从下到上 区域传值-1 |
| regionPoint | Object[] | 是 | 区域 区域的点的坐标,最多10个点，点的个数>=2,线检测点的个数必须为2 (详情见下表) |
regionPoint内容如下:
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| x | int | 是 | 坐标 x 小于最大宽度 |
| y | int | 是 | 坐标 y 小于最大高度 |
time内容如下:
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| allTime | boolean | 是 | 全时段布防 |
| timePeriods | object [] | 是 | 布防时段，时间段个数不能大于 maxTimePeriods(详情见下表) |
timePeriods内容如下:
| 名称 | 类型 | 是否必须 | 备注 |
|---|---|---|---|
| startTime | string | 是 | 开始时间 HHmmss |
| endTime | string | 是 | 结束时间 HHmmss |
| week | int | 是 | -1：每天 1：星期一 2：星期二 3：星期三 4：星期四 5：星期五 6：星期六 7: 星期日 |
//示例数据
{
"code": 1000,
"msg": "OK",
"data": {
"enbale": false,
"params": {
"sensitivity": 88,
"alarmSoundEnable": true,
"region": [
{
"type": 1,
"regionPoint": [
{
"x": 5,
"y": 8
},
{
"x": 6,
"y": 3
}
],
"checkMode": 1
},
{
"type": 0,
"regionPoint": [
{
"x": 10,
"y": 8
},
{
"x": 15,
"y": 20
},
{
"x": 18,
"y": 20
}
],
"checkMode": -1
}
],
"time": {
"allTime": true,
"timePeriods": [{
"startTime": "000000",
"endTime": "235959",
"week": -1
}, {
"startTime": "000000",
"endTime": "235959",
"week": 1
}, {
"startTime": "000000",
"endTime": "235959",
"week": 6
}]
}
},
"maxWidth": 200,
"maxHeight": 300,
"maxRegions": 4,
"maxTimePeriods": 4
}
}
错误码
| 状态码 | 状态描述 |
|---|---|
| 1000 | 成功 |
| 1001 | 参数错误 |
| 1002 | 请求异常 |
| 1006 | AccessToken异常或过期 |
| 2002 | 设备不在线 |
| 2008 | 设备不存在 |
| 2009 | 视频通道号不合法 |