algorithm.package.region (Read algorithm package region property)
algorithm.package.region: Read algorithm package region property
algorithm.package.region · device scope · permission Config
What it does
Reads algorithm package regions on the device. Up to 100 entries.
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. See Permission codes. Shared devices must satisfy one alias in the capability row share_auth_code (for example Config,config).
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 |
properties | Array | yes | ["algorithm.package.region"] |
For common request fields and signing, see Signing conventions and Common request payload.
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",
"properties": [
"algorithm.package.region"
]
}
}
Response data fields
The value is in result.data.properties["algorithm.package.region"].
Array limit 100.
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
item.name | Name. | text | yes | String |
item.type | Region type. | enum | yes | 0 all; 1 human detection; 2 vehicle detection; 3 pet detection; 4 human region intrusion; 5 no-person appearance; 6 vehicle region intrusion; 7 loitering detection; 8 absence-from-post detection; 9 vehicle guard; 10 illegal parking |
item.points | Region coordinates. Coordinate string; format defined by the device or thing model. | text | yes | String |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"algorithm.package.region": [
{
"name": "example",
"type": "0",
"points": "[0,0,100,0,100,100,0,100]"
}
]
}
}
}
}
Error codes
| 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.
| Code | Meaning | Next step |
|---|---|---|
DV2003 | Property not on device | Use device.capability.list |
DV2004 | Value out of range | Check properties values |
DV2007 | channelId vs scope mismatch | Required for channel scope; omit for device scope |
DV2008 | Mixed device and channel properties | Split the request |
DV2009 | productId mismatch | Omit or set actual model id |
See Capability errors.