Дерево страниц

Вы просматриваете старую версию данной страницы. Смотрите текущую версию.

Сравнить с текущим просмотр истории страницы

« Предыдущий Версия 30 Следующий »

ДОСТУПНО В BUSINESS ПОДПИСКЕ

Запрос: GET /enrollment/{enrollment_id}

Права для выполнения запроса

Владелец аккаунтаАдминистратор аккаунтаАдминистратор подразделения, Автор или роль с индивидуальными настройками.

Заголовки и параметры запроса

Заголовок

Описание

Authorization (обязательный)Токен доступа. Вы можете получить токен с помощью запроса
ПараметрОписание

enrollmentId (обязательный)

ID назначения, о котором вы хотите получить информацию

enrollmentIds (необязательный)

Фильтр поиска нескольких ID назначений

Параметры ответа

ПараметрОписание

response

Массив с данными о назначении
enrollmentIdID назначения
courseIdID курса
learnerIdID учащегося, на которого назначен курс
accessDateДата начала обучения
dueDate (необязательный)Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения
expirationDate (необязательный)Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения и shouldLockAfterDueDate=1
shouldLockAfterDueDate

Запрет доступа после окончания срока выполнения.

Возможные значения:

0 — доступ разрешен,

1 — доступ запрещен

enrollmentTypeGroup

Параметр показывает тип назначения.

Возможные значения:

0 — назначено администратором,

1 — добавлено из каталога

Коды ответов

Код

Текст

Описание

200OKЗапрос успешно обработан. Тело ответа будет содержать данные с информацией о назначении в xml
400Bad RequestОшибка в запросе
401UnauthorizedОшибка авторизации
403Permission DeniedУ пользователя недостаточно прав для получения информации о назначении

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

GET /enrollment/3fa85f64-5717-4562-b3fc-2c963f66afa6 https/1.1
Host: api-learn.ispringlearn.ru 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

Пример ответа

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>
  • Нет меток