.. meta::
  :description: Добавление адреса группы, управление группами, добавление пользователя в группу


======
Группы
======

Список групп
============

::

    GET /domains/{domain_id}/groups


Ответ
-----

.. code-block:: javascript

    HTTP 200 OK

    [
      {
        "id": 12383,
        "name": "programmers",
        "created_at": "2013-01-04T16:33:07Z",
        "user_count": 10,
        "reply": false
      }
    ]


Добавление группы
=================

::

    POST /domains/{domain_id}/groups


Параметры
---------

name: required: string
    Имя группы

.. code-block:: javascript

    {
      "name": "programmers"
    }


Ответ
-----

.. code-block:: javascript

    HTTP 201 CREATED

    {
      "id": 12383,
      "name": "programmers",
      "created_at": "2013-01-04T16:33:07Z",
      "user_count": 0,
      "reply": true
    }


Ошибки
------

+------+----------------------------------------------------+
| code | message                                            |
+======+====================================================+
| 160  | Невозможно создать группу                          |
+------+----------------------------------------------------+


Получение группы
================

::

    GET /domains/{domain_id}/groups/{group_id}


Ответ
-----

.. code-block:: javascript

    HTTP 200 OK

    {
      "id": 12383,
      "name": "programmers",
      "created_at": "2013-01-04T16:33:07Z",
      "user_count": 10,
      "reply": false
    }


Редактирование группы
=====================

::

    PUT /domains/{domain_id}/groups/{group_id}


Поля
----

reply: optional: boolean
    Флаг, отвечающий за добавление адреса группы в список адресатов при ответе
    на рассылку

.. code-block:: javascript

    {
      "reply": false
    }


Ответ
-----

.. code-block:: javascript

    HTTP 200 OK

    {
      "id": 65072,
      "name": "news",
      "created_at": "2013-01-04T16:33:07.022Z",
      "user_count": 10,
      "reply": false
    }


Ошибки
------

+------+---------------------------------------------------+
| code | message                                           |
+======+===================================================+
| 163  | Невозможно отредактировать группу                 |
+------+---------------------------------------------------+


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

::

    DELETE /domains/{domain_id}/groups/{group_id}


Ответ
-----

.. code-block:: javascript

    HTTP 204 NO CONTENT


Ошибки
------

+------+---------------------------------------------------+
| code | message                                           |
+======+===================================================+
| 133  | Ошибка удаления группы, попробуйте повторить      |
|      | операцию                                          |
+------+---------------------------------------------------+
| 134  | Невозможно удалить ящик по умолчанию.             |
|      | Смените его в Настройках.                         |
+------+---------------------------------------------------+
| 164  | Невозможно удалить последнюю группу пользователя  |
+------+---------------------------------------------------+


Список пользователей группы
===========================

::

    GET /domains/{domain_id}/groups/{group_id}/users


Ответ
-----

.. code-block:: javascript

    HTTP 200 OK

    {
      "paging": {...},
      "data": [
        {
          "id": 3617,
          "username": "alex",
          "email": "alex@test.com",
          "added_at":  "2013-01-04T16:33:07Z"
        }
      ]
    }

Список пользователей группы разбивается на страницы. Механизм постраничной навигации
описан в разделе :ref:`Pagination`.


Добавление пользователя в группу
================================

::

    POST /domains/{domain_id}/groups/{group_id}/users


Параметры
---------

id: required: integer
    Идентификатор пользователя

.. code-block:: javascript

    {
      "id": 3617
    }


Ответ
-----

.. code-block:: javascript

    HTTP 201 CREATED

    {
      "id": 3617,
      "username": "alex",
      "email": "alex@test.com",
      "added_at": "2013-01-04T16:33:07Z"
    }


Ошибки
------

+------+----------------------------------------------------+
| code | message                                            |
+======+====================================================+
| 162  | Невозможно добавить пользователя в группу          |
+------+----------------------------------------------------+


Удаление пользователя из группы
===============================

::

    DELETE /domains/{domain_id}/groups/{group_id}/users/{user_id}


Ответ
-----

.. code-block:: javascript

    HTTP 204 NO CONTENT