setLocalRecordPlanRules (setLocalRecordPlanRules: Set device local recording plan)

setLocalRecordPlanRules: setLocalRecordPlanRules: Set device local recording plan

Deprecated: Use Recording plan (record.plan.plan). This legacy HTTP page is retained for existing integrations.

Function details

Set the local recording plan of the device. During the recording plan time period, the device will collect all the video data to the local storage of the device.

Remarks:
The device needs to have the LocalRecord capability set to support the device's local recording configuration
If the recording plan is not set by default, the device will only store the recording data associated with the device alarm event
At most 128 rules entries per request; exceeding the limit returns PARAM_ILLEGAL_VALUE

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/setLocalRecordPlanRules

Request format

HTTP POST. JSON body layout: Request conventions. Sign with Signature.

Error codes

This method may return the codes below. See Return codes and Capability errors for the full catalog.

Gateway and auth (SN / TK / OP)

Code	Meaning	Next step
`SN1001`	Signature error	Check `sign` per Development specification
`TK1002`	Token invalid or expired	Refresh accessToken
`OP1002`	Missing required parameter	Add required fields
`OP1003`	Invalid parameter	Match this page’s parameter table
`OP1009`	Permission denied	Check token and device bind/share grants
`OP1013`	Total call limit exceeded	Reduce call rate
`OP1014`	Daily per-interface limit exceeded	See Interface call limits
`DV1007`	Device offline	Wait until the device is online

See Return codes · OP/SN/TK for the full catalog.

Sub-accounts (SUB)

Code	Meaning	Next step
`SUB1001`–`SUB1002`	Sub-account lacks API permission	Update policy via addPolicy
`SUB1005`	Sub-account token expired	Refresh subAccountToken
`SUB1006`	No device grant for sub-account	Check `Resource` and device serial
`SUB1008`	Sub-account not bound to app	Create and bind the sub-account first

See Return codes · SUB.

Device access and channels (DV10xx)

Code	Meaning	Next step
`DV1007`	Device offline or timeout	Wait for the device to come online
`DV1009`	Device busy	Retry later
`DV1012`	Insufficient share/grant permission	Check sub-account `Permission` / `Resource`
`DV1019`	Capability not supported	Confirm model and capability list
`DV1020`	Channel offline	Check channel status
`DV1026`	Function not supported	Use another API or upgrade firmware
`DV1028`	Not bound or channel missing	Verify `deviceId` / `channelId`

See Return codes · DV.

Local record plan conflicts (YL)

Code	Meaning	Next step
`YL1001`	Local record plan conflict	Adjust plan rules on the device

See Return codes · catalog.

Minimum permissions required for sub-account token request

The sub-account accessToken policy must include Config; channel resource URI is cam:{deviceId}:{channelId}. See Permission codes.

Incoming parameter description

Parameter	Type	Required	Legal value	Description
token	String	Yes		Administrator or sub-account accessToken
deviceId	String	Yes		Device serial number
channelId	String	Yes		Channel number
rules.beginTime	String	Yes	The time format is HH:mm:ss	Start time
rules.endTime	String	Yes	The time format is HH:mm:ss	End time
rules.period	String	Yes	Can be "Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday", and set multiple periods at the same time separated by commas.	Repeat period

Sample input

{
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1599031074,
 "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
 },
 "params":{
 "token":"At_00006acr3456d12312d3grf60147de7ec",
 "deviceId":"TESTQWERXXXX",
 "channelId":"0",
 "rules":[{
 "beginTime":"00:00:00",
 "endTime":"23:59:59",
 "period":"Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday"
 }]
 }
}

Return data field description

No data returned

Sample output

{
 "result":{
 "msg":"The operation was successful.",
 "code":"0"
 },
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}