detection.sentry.plan (Read vehicle guard arming schedule)
detection.sentry.plan: Read vehicle guard arming schedule
detection.sentry.plan · Channel scope · Permission Config
What it does
Reads the vehicle guard arming schedule on this channel. On split models, the response may return only periods or only mode; when model=3, the response usually includes periods. See Set vehicle guard arming schedule for writes.
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 | 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.sentry.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.sentry.plan"
]
}
}
Response data fields
The value is in result.data.properties["detection.sentry.plan"].
| Name | Type | Required | Description |
|---|---|---|---|
periods | array | no | Time periods; used only when mode.model=3. At least one segment; each requires date (weekday 0–6), beginTime, and endTime (THHmmss). Up to 100 items |
periods.item.date | enum | yes | Weekday 0–6 (0 Sunday … 6 Saturday); required on every segment |
periods.item.beginTime | text | yes | Start time of day, THHmmss (e.g. T000000); required on every segment |
periods.item.endTime | text | yes | End time of day, THHmmss (e.g. T235959); required on every segment |
mode | struct | no | Schedule mode; includes model, date |
mode.model | enum | no | 0 all day; 1 daytime only; 2 night only; 3 custom |
mode.date | int | no | Device-side extra time value (0–255, step 1); not a weekday |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"detection.sentry.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.