Вы можете получить информацию о группе с помощью GET запроса на URL: /group/{group_id}.
Права пользователя для выполнения запроса: Владелец аккаунта, Администратор, Администратор подразделения, Автор.
Параметры запроса
Параметр | Описание |
|---|---|
| X-Auth-Account-Url (обязательный) | Базовый URL аккаунта, например, http://my.ispringlearn.ru. |
| X-Auth-Email (обязательный) | Логин Владельца аккаунта, Администратора, Администратора подразделения или Автора. |
| X-Auth-Password (обязательный) | Пароль Владельца аккаунта, Администратора, Администратора подразделения или Автора. |
| group_id (обязательный) | ID группы, о которой вы хотите получить информацию. |
После того как запрос был успешно обработан, отправляется код ответа 200. Тело ответа будет содержать данные с информацией о группе в xml.
Коды ответов
Код | Текст | Description |
|---|---|---|
| 200 | Successful operation | Запрос успешно обработан. |
| 400 | Bad Request | Ошибка в запросе. |
| 401 | Unauthorized | Ошибка авторизации. |
| 403 | Permission Denied | У пользователя недостаточно прав для получения информации о группе. |
Пример запроса
GET /group/b1496214-acab-11e9-8db0-120a62f268a9 HTTP/1.1 Host: api-learn.ispringlearn.ru X-Auth-Account-Url: http://myaccount.ispringlearn.ru X-Auth-Email: email@email.com X-Auth-Password: password
Пример ответа
HTTP/1.1 200 Successful operation Connection: close <?xml version="1.0" encoding="UTF-8"?> <response> <response> <groupId>3fa85f64-5717-4562-b3fc-2c963f66afa6</groupId> <name>Отдел продаж</name> <usersCount>1</usersCount> <isSmart>0</isSmart> <userIds> <id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id> </userIds> </response> </response>