detection.trip.plan (Read tripwire arming schedule)
detection.trip.plan: Read tripwire arming schedule
detection.trip.plan · Channel scope · Permission Config
What it does
Reads the tripwire arming schedule on this channel—separate schedules for person and vehicle. On split models, the response may return only personPeriods/personMode or vehiclePeriods/vehicleMode; when model=3, the matching periods are usually included. See Set tripwire arming schedule.
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.trip.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.trip.plan"
]
}
}
Response data fields
The value is in result.data.properties["detection.trip.plan"].
| Name | Type | Required | Description |
|---|---|---|---|
personPeriods | array | no | Person time periods when personMode.model=3; 1–21 segments; each needs date, beginTime, endTime (THHmmss) |
personMode | struct | no | Person schedule mode; includes model, date |
personMode.model | enum | no | 0 all day; 1 daytime; 2 night; 3 custom |
personMode.date | int | no | Device extra time value 0–255 (not weekday) |
vehiclePeriods | array | no | Vehicle periods when vehicleMode.model=3; same rules as personPeriods |
vehicleMode | struct | no | Vehicle schedule mode |
vehicleMode.model | enum | no | Same values as personMode.model |
vehicleMode.date | int | no | Same as personMode.date |
Weekday date on each period segment: 0 Sunday … 6 Saturday.
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"detection.trip.plan": {
"personMode": { "model": 0, "date": 127 },
"vehicleMode": { "model": 0, "date": 127 }
}
}
}
}
}
Error codes
Gateway and device error codes are in Global return codes.