Delete an Administrator Group

Request Parameter

Parameter

Description

Mandatory

ID of administrator group to be deleted.

This parameter can be repeated any number of times per request to delete multiple administrator groups at a time.

yes

Administrator group cannot be deleted, if it is a root group or a parent group.

Request Example

https://192.168.1.1:9081/api/admingroups/delete.ds?id=adm4&id=adm5

XML and JSON response structure examples are described below.

XML Response Structure

<drweb-es-api api_version="4.3.2" timestamp="1588501652" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<admin-groups total="2">
<admin-group id="adm4"/>

<admin-group id="adm5"/>
</admin-groups>
</drweb-es-api>

Description of XML Response Parameters

The <admin-groups /> element contains information about deleted administrator groups specified in the request.

The <admin-groups /> element attribute:

Attribute	Description
total	Total number of deleted administrator groups in the response

•The <admin-group /> element contains ID of a specific administrator group that was deleted.

The <admin-group /> element attribute:

Attribute	Description
id	Group ID

JSON Response Structure

{ "head": {
"status": true,

"timestamp": 1588501746,

"api": {
"version": 40302,
"versionString": "4.3.2"},

"server": {
"name": "192.168.1.1",

"version": "13.00.1.202310121",
"uuid": "78b77680-8080-11ea-701a-44a527d9115c"}},

"data": {
"admingroups": {
"total": 2,

"list": [
{"id": "adm4"},
{"id": "adm5"}]}}}

Description of JSON Response Parameters

The admingroups element contains information about deleted administrator groups specified in the request.

The admingroups block elements:

Field name	Description
total	Total number of deleted administrator groups in the response
list	Deleted administrator group ID array

•Elements in the list array:

Field name	Description
id	Group ID