Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
      • Common methods
      • Detection and alarms
        • Arming
        • Attention zone
        • People counting
        • Cry detection
        • Absence from post
        • Face recognition
        • Fall detection
        • Gesture call
        • Intrusion
        • Loitering
        • Minor detection
        • Person and vehicle mix
        • Motion detection
        • Video occlusion
        • Illegal parking
        • Person detection
        • Pet detection
        • PIR
        • License plate recognition
        • Vehicle guard
          • detection.sentry.enabled (Read vehicle guard switch)
          • detection.sentry.enabled (Set vehicle guard switch)
          • detection.sentry.plan (Read vehicle guard arming schedule)
          • detection.sentry.plan (Set vehicle guard arming schedule)
          • detection.sentry.detected (Vehicle guard detected)
        • Siren
        • Voice SOS
        • Abnormal sound
        • Tripwire
        • Unoccupied detection
        • Vehicle
        • Door contact
        • Tamper
        • Gate accessory
        • Environment sensing
        • Target detection frame
      • Image
      • PTZ
      • Light
      • Recording
      • Audio
      • Media
      • Network
      • Power
      • Privacy
      • Call
      • Storage
      • System
      • Algorithm
      • Maintenance
      • Control
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
What it does
Request URL
Minimum permission
Request parameters
Request example
Response data fields
Response example
Error codes

detection.sentry.plan (Set vehicle guard arming schedule)

detection.sentry.plan: Set vehicle guard arming schedule

detection.sentry.plan · Channel scope · Permission Config

What it does

Sets the vehicle guard arming schedule on this channel. mode: 0 all day / 1 daytime only / 2 night only / 3 custom; custom mode must include periods (each segment: date, beginTime, endTime). Out-of-range values are rejected, not truncated.

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

NameTypeRequiredDescription
tokenStringyesAdministrator, sub-user, or sub-account accessToken
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009
channelIdStringyesChannel ID; "0" is common on IPCs
propertiesObjectyesKey is detection.sentry.plan
NameTypeRequiredDescription
periodsarraynoTime periods; used only when mode.model=3. At least one segment; each requires date, beginTime, endTime (THHmmss). Up to 100 items
periods.item.dateenumyesWeekday 0–6 (0 Sunday … 6 Saturday)
periods.item.beginTimetextyesStart time THHmmss
periods.item.endTimetextyesEnd time THHmmss
modestructnoWhen writing mode, include model. If model=3, also write periods
mode.modelenumyes0 all day; 1 daytime; 2 night; 3 custom
mode.dateintnoDevice-side extra time value 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.sentry.plan": {
 "mode": {
 "model": 0,
 "date": 127
 }
 }
 }
 }
}

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.

Read vehicle guard arming schedule · Vehicle guard

detection.sentry.plan (Read vehicle guard arming schedule)
detection.sentry.detected (Vehicle guard detected)