Запрос: GET /enrollment/{enrollment_id}
Оглавление minLevel 2
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Заголовки и параметры запроса
Заголовок | Описание |
|---|---|
| X-Auth-Account-Url (обязательный) | Базовый URL аккаунта, например, https://myaccount.ispringlearn.ru. |
| X-Auth-Email (обязательный) | Логин Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. |
| X-Auth-Password (обязательный) | Пароль Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. |
| Параметр | Описание |
enrollment_id (обязательный) | ID назначения, о котором вы хотите получить информацию. |
Параметры ответа
| Параметр | Описание |
|---|---|
response | Массив с данными о назначении. |
| enrollmentId | ID назначения. |
| courseId | ID курса. |
| learnerId | ID учащегося, на которого назначен курс. |
| accessDate | Дата начала обучения. |
| dueDate (необязательный) | Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения. |
| expirationDate (необязательный) | Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения и shouldLockAfterDueDate=1. |
| shouldLockAfterDueDate | Запрет доступа после окончания срока выполнения. Возможные значения: 0 — доступ разрешен 1 — доступ запрещен |
Коды ответов
Код | Текст | Описание |
|---|---|---|
| 200 | OK | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о назначении в xml. |
| 400 | Bad Request | Ошибка в запросе. |
| 401 | Unauthorized | Ошибка авторизации. |
| 403 | Permission Denied | У пользователя недостаточно прав для получения информации о назначении. |
Пример запроса
| Блок кода | ||
|---|---|---|
| ||
GET /enrollment/3fa85f64-5717-4562-b3fc-2c963f66afa6 https/1.1 Host: api-learn.ispringlearn.ru X-Auth-Account-Url: https://my.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> <response> <enrollmentId>3fa85f64-5717-4562-b3fc-2c963f66afa6</enrollmentId> <courseId>3fa85f64-5717-4562-b3fc-2c963f66afa6</courseId> <learnerId>3fa85f64-5717-4562-b3fc-2c963f66afa6</learnerId> <accessDate>2019-09-24</accessDate> <dueDate>2019-09-26</dueDate> <expirationDate>2019-09-26</expirationDate> <shouldLockAfterDueDate>1</shouldLockAfterDueDate> </response> </response> |