Range
Function
This API is used to get Access Control > Door Parameters parameter range.
Request Message
Parameter Description
Table 1
| Parameter | Range | Type | Description |
|---|---|---|---|
| channel | "CH1"…"CHx" | string array | The channels supported by the device. |
Sample:
POST /API/AccessControl/DoorParameters/Range HTTP/1.1
{
"version": "1.0",
"data": {}
}
Response Message
Parameter Description
Table 2
| Parameter | Range | Type | Description |
|---|---|---|---|
| channel_info | object | Total channel information see Table 3. | |
| channel_max | int | The maximum number of channels. |
Table 3
| Parameter | Range | Type | Description |
|---|---|---|---|
| CH1…CHx | object | See Table 4 |
Table 4
| Parameter | Range | Type | Description |
|---|---|---|---|
| door_name | string | Door Name | |
| open_duration | 1-255 | unsigned int | Door Open Duration |
| disability_card_open_duration | 5-255 | unsigned int | Disability Card Open Duration |
| door_open_timeout_alarm | 1-255 | unsigned int | Door Open Timeout Alarm |
| door_magnetic_sensor_type | "Normal Close""Normal Open" | string | Door Magnetic Sensor Type |
| exit_button_type | "Normal Close""Normal Open" | string | Exit Button Type |
| door_lock_status | "Normal Close""Normal Open" | string | Door Lock Status |
Sample:
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": "success",
"data": {
"channel_max": 1,
"channel_info": {
"type": "object",
"items": {"CH1": {
"type": "object",
"items": {
"door_name": {
"type": "string",
"min_len": 0,
"max_len": 127
},
"open_duration": {
"type": "uint32",
"mode": "r",
"min": 1,
"max": 255,
"default_value": 5
},
"disability_card_open_duration": {
"type": "uint32",
"mode": "r",
"min": 5,
"max": 255,
"default_value": 20
},
"door_open_timeout_alarm": {
"type": "uint32",
"mode": "r",
"min": 1,
"max": 255,
"default_value": 30
},
"door_magnetic_sensor_type": {
"type": "string",
"items": [
"Normal Close",
"Normal Open"
]
},
"exit_button_type": {
"type": "string",
"items": [
"Normal Close",
"Normal Open"
]
},
"door_lock_status": {
"type": "string",
"items": [
"Normal Close",
"Normal Open"
]
}
}
}}
}
}
}
Error Code
See Response Messages Body and Common error_code for more information.