queryLocalRecordBitmap (queryLocalRecordBitmap: Query local recording mask monthly)

queryLocalRecordBitmap: queryLocalRecordBitmap: Query local recording mask monthly

Legacy HTTP retained: New integrations can use Local recording bitmap (record.file.bitmap) for the related capability. The two interfaces are not a one-to-one replacement. The capability leaf exists, but registry does not map this old OpenAPI one-to-one.

Function details

Query the mask of the video coverage of the device/channel in a certain year and month, and return the Bitmap, indicating whether there is a video on each day of the month, 1 means there is a video, and 0 means there is no video.

Request address

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

Request format

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

Minimum permissions required for sub-account token request

"Permission":"RecordReplay" "Resource":"cam:serial number:channel number"

Incoming parameter description

Parameter name	Parameter type	Required or not	Legal value	Parameter description
token	String	Yes		Administrator or sub-account accessToken
deviceId	String	Yes		Device serial number
channelId	String	Yes		Channel ID
year	Integer	Yes	[1,N] (N is a positive integer)	year
month	Integer	yes	[1,12] positive integer	month

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",
 "year":2020,
 "month":5
 }
}

Return data field description

Field	Type	Description
bitmap	String	Local video mask

Sample output

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

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.