Запрос: GET /group/{group_id}
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками.
Автор получает информацию о количестве пользователей, но не получает их ID.
Заголовки и параметры запроса
Заголовок | Описание |
|---|---|
| X-Auth-Account-Url (обязательный) | Базовый URL аккаунта, например, https://myaccount.ispringlearn.ru. |
| X-Auth-Email (обязательный) | Логин Владельца аккаунта, Администратора, Администратора подразделения или пользователя с ролью с индивидуальными настройками. |
| X-Auth-Password (обязательный) | Пароль Владельца аккаунта, Администратора, Администратора подразделения или пользователя с ролью с индивидуальными настройками. |
| Параметр | Описание |
| group_id (обязательный) | ID группы, о которой вы хотите получить информацию. |
Параметры ответа
| Параметр | Описание |
|---|---|
| group | Массив с данными о группе. |
| usersCount | Количество пользователей в группе. |
| groupId | ID группы. |
| userIds | Массив с ID пользователей. |
| id | ID пользователя. |
| name | Название группы. |
| isSmart | Является ли группа смарт-группой. Возможные значения: 0 — не является смарт-группой 1 — является смарт-группой |
Коды ответов
Код | Текст | Description |
|---|---|---|
| 200 | OK | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о группе в xml. |
| 400 | Bad Request | Ошибка в запросе. |
| 401 | Unauthorized | Ошибка авторизации. |
| 403 | Permission Denied | У пользователя недостаточно прав для получения информации о группе. |
Пример запроса
GET /group/b1496214-acab-11e9-8db0-120a62f268a9 https/1.1 Host: api-learn.ispringlearn.ru X-Auth-Account-Url: https://myaccount.ispringlearn.ru X-Auth-Email: email@email.com X-Auth-Password: password
Пример ответа
https/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
<group>
<usersCount>1</usersCount>
<userIds>
<id>1250ac9a-3c12-11ed-957b-5607de77b3b8</id>
</userIds>
<groupId>6b2d3e10-e043-11e9-8511-0a580af40b37</groupId>
<name>Стажеры</name>
<isSmart>0</isSmart>
</group>
</response>