detection.counting.region (Read people-counting region)
detection.counting.region: Read people-counting region
detection.counting.region · Channel scope · Permission Config
What it does
Reads people-counting regions on this channel. Up to 100 entries with id, boundaryPoints, name, type, points, direction, rule (see response table).
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 | accessToken for administrator, sub-user, or sub-account |
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 number; "0" is common on IPCs |
properties | Array | yes | ["detection.counting.region"] |
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.counting.region"
]
}
}
Response data fields
The value is in result.data.properties["detection.counting.region"].
Array limit 100.
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
item.name | Name. | text | yes | string |
item.type | Region type. | enum | yes | 0 People-counting region |
item.points | Region coordinates. Coordinate string per device/TSL. | text | yes | string |
item.direction | Direction. 0 A->B, 1 B->A. | enum | yes | 0 A->B; 1 B->A |
item.rule | Rule. | enum | yes | 0 enter; 1 exit; 2 enter and exit |
item.boundaryPoints | Boundary points (example: [5,5,5,5]). | text | yes | string |
item.id | Region ID. Range 0-999999, step 1. | int | yes | 0-999999, step 1 |
Response example
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"detection.counting.region": [
{
"name": "example",
"type": "0",
"points": "[0,0,100,0,100,100,0,100]",
"direction": "0",
"rule": "0",
"boundaryPoints": "[0,0,100,0,100,100,0,100]",
"id": 0
}
]
}
}
}
}
Error codes
Gateway and device error codes are in Global return codes.