|
Request Parameter
Parameter
|
Description
|
Mandatory
|
id
|
Group ID.
This parameter can be repeated any number of times per request to delete multiple groups at a time.
|
yes
|
Request Example
https://192.168.1.1:9081/api/groups/delete.ds?id=1001&id=1002
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.0" timestamp="1587994891" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<groups total="1">
<group id="1001"/>
<group id="1002"/>
</groups>
</drweb-es-api>
|
Description of XML Response Parameters
The <groups /> element contains information about deleted groups specified in the request.
The <groups /> element attribute:
Attribute
|
Description
|
total
|
Total number of deleted groups in a response
|
•The <group /> element contains ID of a specific group that was deleted. The <group /> element attribute:
Attribute
|
Description
|
id
|
Group ID
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1587994967,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "25cf53c0-885a-11ea-5c35-289def4dadcb"}},
"data": {
"groups": {
"total": 1,
"list": [
{"id": "1001"},
{"id": "1002"}]}}}
|
Description of JSON Response Parameters
The groups block contains information about deleted groups specified in the request.
The groups block elements:
Field name
|
Description
|
total
|
Total number of deleted groups in a response
|
list
|
Array of deleted group IDs
|
•Elements in the list array:
Field name
|
Description
|
id
|
Group ID
|
|