detection.loitering.plan (Set loitering arming schedule)
detection.loitering.plan: Set loitering arming schedule
detection.loitering.plan · Channel scope · Permission Config
What it does
Sets loitering arming on this channel. mode: 0 all day / 1 daytime only / 2 night only / 3 custom; custom mode must include periods (each segment needs date, beginTime, endTime). Out-of-range values are rejected, not clamped.
Request URL
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.set
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. A write timeout does not mean the operation did not run.
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
token | String | yes | Administrator, sub-user, or sub-account accessToken |
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 ID; "0" is common on IPCs |
properties | Object | yes | key is detection.loitering.plan |
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
periods | Time periods. Used only when mode.model=3. At least one segment; each needs date (weekday 0–6), beginTime, endTime (THHmmss). | array | no | up to 21 entries |
periods.item.date | Weekday 0–6. Required on every segment. | enum | yes | 0 Sunday; 1 Monday; 2 Tuesday; 3 Wednesday; 4 Thursday; 5 Friday; 6 Saturday |
periods.item.beginTime | Start time within the day, format THHmmss (e.g. T000000). Required on every segment. | text | yes | Format THHmmss, e.g. T235959 |
periods.item.endTime | End time within the day, format THHmmss (e.g. T235959). Required on every segment. | text | yes | Format THHmmss, e.g. T235959 |
mode | Schedule mode: 0 all day / 1 daytime / 2 night / 3 custom. Include model when writing. When 3, also write periods (each with date, beginTime, endTime). | struct | no | contains model, date |
mode.model | Mode enum. Required when writing mode. When 3, also write periods. | enum | yes | 0 all day; 1 daytime only; 2 night only; 3 custom |
mode.date | Device-side auxiliary time value (int 0–255), not weekday. | int | no | 0–255, step 1 |
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.loitering.plan": {
"mode": { "model": 3, "date": 0 },
"periods": [
{ "date": 1, "beginTime": "T090000", "endTime": "T180000" }
]
}
}
}
}
Response data fields
On success, code is "0" and data is {}.
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {}
}
}
Error codes
Gateway and device error codes are in Global return codes.