Request Parameter
Parameter
|
Description
|
Mandatory
|
login
|
Administrator account login.
This parameter can be repeated any number of times per request to delete multiple administrator accounts at a time.
|
yes
|
Request Example
https://192.168.1.1:9081/api/admins/delete.ds?login=adm4&login=adm5
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1582030257" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<administrators total="2">
<administrator id="1000"/>
<administrator id="1001"/>
</administrators>
</drweb-es-api>
|
Description of XML Response Parameters
The <administrators /> element contains information about deleted administrator accounts that were specified in the request.
The <administrators /> element attribute:
Attribute
|
Description
|
total
|
Total number of deleted accounts in the response
|
•The <administrator /> element contains ID of a specific deleted account.
The <administrator /> element attribute:
Attribute
|
Description
|
id
|
Account ID
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1582030514,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "eae1a652-96d5-48fd-9169-4788a03688b8"}},
"data": {
"admins": {
"total": 2,
"list": [
{"id": "1000"},
{"id": "1001"}]}}}
|
Description of JSON Response Parameters
The admins block contains information about deleted administrator accounts that were specified in the request.
The admins block elements:
Field name
|
Description
|
total
|
Total number of deleted accounts in the response
|
list
|
Deleted account ID array
|
•Elements in the list array:
Field name
|
Description
|
id
|
Account ID
|
|