Range
Function
This API is used to get parameter range for System > User page.
Note:
The Range provides reference information for client UI input limits and API request limits. When sending Get and Set requests, the parameters must be strictly limited according to the Range, otherwise the request may be rejected by the device.
Request Message
None.
Sample:
POST /API/SystemConfig/User/Range HTTP/1.1
{
"version": "1.0",
"data": {}
}
Response Message
Parameter Description
Table 1
| Parameter | Range | Type | Description |
|---|---|---|---|
| user_info | object | User info object,see Table 2 for more information |
Table 2
User info object
| Parameter | Range | Type | Description |
|---|---|---|---|
| user | ADMIN USER1 USER2 USER3 USER4 USER5 USER6 | object | User object,see Table 3 for more information |
Table 3
User object
| Parameter | Range | Type | Description |
|---|---|---|---|
| user_state | None Normal NotYetStart Expires ExpiresClearInfo | string | "None":User not in use. "Normal":User is normal. "NotYetStart":User not started yet. "Expires"：Expired, user information will be cleared three days after the expires time. "ExpiresClearInfo":Expired, user information has been cleared. |
| user_enable | boolean | boolean | Enable user. |
| username | Max length: 16 bytes | string | User name. |
| password_enable | boolean | boolean | Enable user password. IPC does not use this field, a password must be set. |
| password_empty | boolean | boolean | Only for Get request.The client does not receive the password, this field is used to determine whether the password has been set. |
| password | Max length: 16 bytes | string | User password.Only for Set request. |
| confirm_password | Max length: 16 bytes | string | Confirm user password.Only for Set request. |
| login_num | 1-5 | int32 | Maximum simultaneous login limit for this user. |
| permission | object | Permission object,see Table 4 for more information | |
| base_enc_password | object | Encrypted password. |
Table 4
Permission object
| Parameter | Range | Type | Description |
|---|---|---|---|
| log_search | boolean | boolean | Log permission |
| parameter | boolean | boolean | Parameter setting permission |
| auto_reboot | boolean | boolean | Auto reboot permission |
| manual_record | boolean | boolean | Manual record permission |
| disk | boolean | boolean | Disk permission,IPC does not use this field. |
| remote_login | boolean | boolean | Remote login permission,IPC does not use this field. |
| seq_control | boolean | boolean | SEQ control permission,IPC does not use this field. |
| manual_capture | boolean | boolean | Manual capture permission |
| audio | boolean | boolean | Audio permission |
| backup_enable | boolean | boolean | Backup permission,only for NVR |
| live_enable | boolean | boolean | Preview permission |
| playback_enable | boolean | boolean | Video playback permission |
| ptz_enable | boolean | boolean | Ptz control permission |
| backup_channel | CH1 CH2 ... CHx IP_CH1 ... IP_CHx WIFI_CH1 ... WIFI_CHx | string array | Backup channels,only for NVR. The number of channels depends on the device model. |
| live_channel | CH1 CH2 ... CHx IP_CH1 ... IP_CHx WIFI_CH1 ... WIFI_CHx | string array | Backup channels,only for NVR. The number of channels depends on the device model. |
| playback_channel | CH1 CH2 ... CHx IP_CH1 ... IP_CHx WIFI_CH1 ... WIFI_CHx | string array | Backup channels,only for NVR. The number of channels depends on the device model. |
| ptz_channel | CH1 CH2 ... CHx IP_CH1 ... IP_CHx WIFI_CH1 ... WIFI_CHx | string array | Backup channels,only for NVR. The number of channels depends on the device model. |
| rtsp_right | boolean | boolean | Rtsp permission,only for IPC. |
| license_plate | boolean | boolean | License plate permission |
Tips:
The response message of the Range request may not contain all the fields in the above table, and the fields not included indicate that the device does not support this parameter configuration.
Admin response message
Sample:
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": "success",
"data": {
"user_info": {
"type": "object",
"items": {
"ADMIN": {
"type": "object",
"items": {
"user_enable": {
"type": "bool"
},
"username_enable": {
"type": "bool"
},
"username": {
"type": "string",
"min_len": 1,
"max_len": 16
},
"login_num": {
"type": "int32",
"mode": "rw",
"min": 1,
"max": 5
},
"password_strength": {
"type": "string",
"items": [
"Low",
"Medium",
"High"
]
},
"password_disable": {
"type": "bool"
},
"password_empty": {
"type": "bool"
},
"password": {
"type": "string",
"min_len": 8,
"max_len": 16
},
"confirm_password": {
"type": "string",
"min_len": 8,
"max_len": 16
},
"secondary_authentication": {
"type": "string",
"min_len": 8,
"max_len": 16
}
}
},
"USER1": {
"type": "object",
"items": {
"user_enable": {
"type": "bool"
},
"username_enable": {
"type": "bool"
},
"username": {
"type": "string",
"min_len": 1,
"max_len": 16
},
"login_num": {
"type": "int32",
"mode": "rw",
"min": 1,
"max": 5
},
"password_strength": {
"type": "string",
"items": [
"Low",
"Medium",
"High"
]
},
"password_disable": {
"type": "bool"
},
"password_empty": {
"type": "bool"
},
"password": {
"type": "string",
"min_len": 8,
"max_len": 16
},
"confirm_password": {
"type": "string",
"min_len": 8,
"max_len": 16
},
"secondary_authentication": {
"type": "string",
"min_len": 8,
"max_len": 16
},
"permission": {
"type": "object",
"items": {
"parameter": {
"type": "bool"
},
"log_search": {
"type": "bool"
},
"auto_reboot": {
"type": "bool"
},
"disk": {
"type": "bool"
},
"manual_record": {
"type": "bool"
},
"remote_login": {
"type": "bool"
},
"seq_control": {
"type": "bool"
},
"manual_capture": {
"type": "bool"
},
"audio": {
"type": "bool"
},
"face_search": {
"type": "bool"
},
"license_plate": {
"type": "bool"
},
"change_password": {
"type": "bool"
},
"backup_enable": {
"type": "bool"
},
"live_enable": {
"type": "bool"
},
"playback_enable": {
"type": "bool"
},
"ptz_enable": {
"type": "bool"
},
"backup_channel": {
"type": "array",
"min_size": 0,
"max_size": 16,
"items": {
"type": "string",
"items": [
"CH1",
"CH2",
"CH3",
"CH4",
"CH5",
"CH6",
"CH7",
"CH8",
"CH9",
"CH10",
"CH11",
"CH12",
"CH13",
"CH14",
"CH15",
"CH16"
]
}
},
"live_channel": {
"type": "array",
"min_size": 0,
"max_size": 16,
"items": {
"type": "string",
"items": [
"CH1",
"CH2",
"CH3",
"CH4",
"CH5",
"CH6",
"CH7",
"CH8",
"CH9",
"CH10",
"CH11",
"CH12",
"CH13",
"CH14",
"CH15",
"CH16"
]
}
},
"playback_channel": {
"type": "array",
"min_size": 0,
"max_size": 16,
"items": {
"type": "string",
"items": [
"CH1",
"CH2",
"CH3",
"CH4",
"CH5",
"CH6",
"CH7",
"CH8",
"CH9",
"CH10",
"CH11",
"CH12",
"CH13",
"CH14",
"CH15",
"CH16"
]
}
},
"ptz_channel": {
"type": "array",
"min_size": 0,
"max_size": 16,
"items": {
"type": "string",
"items": [
"CH1",
"CH2",
"CH3",
"CH4",
"CH5",
"CH6",
"CH7",
"CH8",
"CH9",
"CH10",
"CH11",
"CH12",
"CH13",
"CH14",
"CH15",
"CH16"
]
}
}
}
}
}
},
"USER1": {
...
// Emitted
},
... // Emitted
"USER6": {
...
// Emitted
},
}
}
}
}
Error Code
See Response Messages Body and Common error_code for more information.