detection.intrusion.plan (Read intrusion arming schedule)
detection.intrusion.plan: Read intrusion arming schedule
detection.intrusion.plan · Channel scope · Permission Config
What it does
Reads intrusion arming on this channel (human and vehicle schedules). personMode / vehicleMode: 0 all day / 1 daytime / 2 night / 3 custom; custom requires personPeriods / vehiclePeriods.
Request URL
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get
Minimum permission
The administrator does not need an extra permission on a device they bound. A shared device needs the basic configuration permission. A bound sub-user does not. A sub-account needs Config. Omitting channelId on a channel-scope capability returns DV2007. Mixing device and channel in one request returns DV2008.
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
token | String | yes | accessToken for administrator, sub-user, or sub-account |
deviceId | String | yes | Device serial number |
productId | String | no | Optional. If sent and it does not match the device model → DV2009 |
channelId | String | yes | Channel number; "0" is common on IPCs |
properties | Array | yes | ["detection.intrusion.plan"] |
Common request fields and the signature are in Development specification.
Request example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"system": {
"ver": "1.0",
"appId": "lcdxxxxxxxxx",
"sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
"time": 1706511734,
"nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
},
"params": {
"token": "<yourAccessToken>",
"deviceId": "TESTIPC000012345",
"channelId": "0",
"properties": [
"detection.intrusion.plan"
]
}
}
Response data fields
The value is in result.data.properties["detection.intrusion.plan"].
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
personPeriods | Human schedule periods. Used when personMode.model=3. 1–21 segments; each needs date, beginTime, endTime (THHmmss). | array | no | Up to 21 entries |
personPeriods.item.date | Weekday 0–6. Required per segment. | enum | yes | 0 Sunday; 1 Monday; 2 Tuesday; 3 Wednesday; 4 Thursday; 5 Friday; 6 Saturday |
personPeriods.item.beginTime | Start time of day, format THHmmss, e.g. T000000. | text | yes | Format THHmmss, e.g. T000000 |
personPeriods.item.endTime | End time of day, format THHmmss, e.g. T000000. | text | yes | Format THHmmss, e.g. T000000 |
personMode | Human schedule mode. Include model when writing; custom requires personPeriods. | struct | no | Includes model, date |
personMode.model | Mode. Required when writing personMode. Custom (3) requires personPeriods. JSON number. | enum | yes | 0 all day; 1 daytime; 2 night; 3 custom |
personMode.date | Time. Device-side auxiliary value (int 0–255), not weekday. | int | no | 0–255, step 1 |
vehiclePeriods | Vehicle schedule periods. Used when vehicleMode.model=3. 1–21 segments; each needs date, beginTime, endTime (THHmmss). | array | no | Up to 21 entries |
vehiclePeriods.item.date | Weekday 0–6. Required per segment. | enum | yes | 0 Sunday; 1 Monday; 2 Tuesday; 3 Wednesday; 4 Thursday; 5 Friday; 6 Saturday |
vehiclePeriods.item.beginTime | Start time of day, format THHmmss, e.g. T000000. | text | yes | Format THHmmss, e.g. T000000 |
vehiclePeriods.item.endTime | End time of day, format THHmmss, e.g. T000000. | text | yes | Format THHmmss, e.g. T000000 |
vehicleMode | Vehicle schedule mode. Include model when writing; custom requires vehiclePeriods. | struct | no | Includes model, date |
vehicleMode.model | Mode. Required when writing vehicleMode. Custom (3) requires vehiclePeriods. | enum | yes | 0 all day; 1 daytime; 2 night; 3 custom |
vehicleMode.date | Time. Device-side auxiliary value (int 0–255), not weekday. | int | no | 0–255, step 1 |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"detection.intrusion.plan": {
"personMode": {
"model": 0,
"date": 0
},
"vehicleMode": {
"model": 0,
"date": 0
}
}
}
}
}
}
Error codes
Gateway and device error codes are in Global return codes.