Request Parameters
Parameter
|
Description
|
Obligatory
|
id
|
Group identifier.
This parameter can be defined in the request several times to delete multiple groups at a time.
|
yes
|
Request Example
http://192.168.1.1:9080/api/groups/delete.ds?id=4
|
XML and JSON response structure examples are described below.
XML Response
<drweb-es-api api_version="4.3.0" timestamp="1551503301" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<groups total="1">
<group id="4"/>
</groups>
</drweb-es-api>
|
Description of XML Response Parameters
The <groups /> element contains information about all deleted groups.
The <groups /> element attribute:
Attribute
|
Description
|
total
|
Total number of groups deleted
|
•The <group /> element contains information about a specific deleted group. Number of the <group /> elements corresponds to the number of deleted groups. The <group /> element attribute:
Attribute
|
Description
|
id
|
Group identifier
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1555735077,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "12.00.0.201909260",
"uuid": "1023dcd7-d11d-b211-896d-8804c0842edb"}},
"data": {
"groups": {
"total": 1,
"list": [{
"id": "4"}]}}}
|
Description of JSON Response Parameters
The groups block contains information about all deleted groups.
The groups block elements:
Field name
|
Description
|
total
|
Total number of groups
|
•The list array contains information about a specific deleted group. Elements in the list array:
Field name
|
Description
|
id
|
Group identifier
|
|