detection.person.plan (Read person arming schedule)

detection.person.plan: Read person arming schedule

detection.person.plan · Channel scope · Permission Config

What it does

Reads person arming on this channel. Split models may return only periods or only mode; when model=3 (custom), the response usually includes both. Write rules: Set person arming schedule.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get

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	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`	Array	yes	`["detection.person.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.person.plan"
 ]
 }
}

Response data fields

The value is in result.data.properties["detection.person.plan"]。

Name	Description	Type	Required	Values
`periods`	Time periods when `mode.model=3`. Each segment has `date`, `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 (THHmmss, e.g. T000000).	`text`	yes	Format `THHmmss`, e.g. `T235959`
`periods.item.endTime`	End time (THHmmss, e.g. T235959).	`text`	yes	Format `THHmmss`, e.g. `T235959`
`mode`	Mode: 0 all day / 1 daytime / 2 night / 3 custom.	`struct`	no	contains `model`, `date`
`mode.model`	Mode enum.	`enum`	no	`0` all day; `1` daytime only; `2` night only; `3` custom
`mode.date`	Device auxiliary time (0–255); weekday is in `periods.item.date`.	`int`	no	`0`–`255`, step `1`

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "detection.person.plan": {
 "mode": { "model": 3, "date": 0 },
 "periods": [
 { "date": 1, "beginTime": "T090000", "endTime": "T180000" }
 ]
 }
 }
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

Set person arming schedule · Person detection