Удаление группы

Параметр запроса

Параметр

Описание

Обязательный

id

Идентификатор группы.

Параметр может быть указан в запросе неограниченное количество раз для удаления нескольких групп одновременно.

да

 

Пример запроса

https://192.168.1.1:9081/api/groups/delete.ds?id=1001&id=1002

Ниже представлены примеры ответов в формате XML и в формате JSON.

 

Ответ в формате XML

<drweb-es-api api_version="4.3.2" 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>

 

Описание параметров ответного XML

Элемент <groups /> содержит информацию об удаленных группах, указанных в запросе.

Атрибут элемента <groups />:

Атрибут

Описание

total

Общее количество удаленных групп в ответе

Элемент <group /> содержит идентификатор конкретной удаленной группы.

Атрибут элемента <group />:

Атрибут

Описание

id

Идентификатор группы

 

Ответ в формате JSON

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

    "timestamp": 1587994967,

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

    "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"}]}}}

 

Описание параметров ответного JSON

Блок groups содержит информацию об удаленных группах, указанных в запросе.

Элементы блока groups:

Название поля

Описание

total

Общее количество удаленных групп в ответе

list

Массив идентификаторов удаленных групп

Элементы объектов в массиве list:

Название поля

Описание

id

Идентификатор группы