Документация по iSpring Learn

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

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

Запрос: GET /enrollments

Вы можете получить список назначений для всего аккаунта, для определенных учащихся и для определенных курсов, а также для двух параметров одновременно.

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

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

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

Заголовок

Описание

Authorization (обязательный)Токен доступа. Вы можете получить токен с помощью запроса
ПараметрОписание
learnerIds (необязательный)ID пользователей, список назначений которых вы хотите получить
courseIds (необязательный)ID материалов, список назначений которых вы хотите получить
pageSize (необязательный)Количество записей на 1 страницу. Если не указан, то 1000
pageToken (необязательный)Токен для перехода на следующую страницу

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

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

response

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

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

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

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

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

certIssueDateДата выдачи сертификата
certExpiryDateДата истечения сертификата
enrollmentTypeGroup

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

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

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

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

Дату выдачи и истечения сертификата можно получить только по активным назначениям. С помощью этого метода нельзя получить данные по архивным и удаленным назначениям.

Коды ответов

Код

Текст

Описание

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

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

GET/enrollments?courseIds[]=c74b4059-f593-11e9-a66a-0a580af40186&learnerIds[]=e9e1b906-0614-11ea-9f83-0a580af40788&pageSize=1000&pageToken=YzljNmM1MTEtZjU5My0xMWU5LWE2NmEtMGE1ODBhZjQwMddddTg28 https/1.1
Host: api-learn.ispringlearn.ru 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

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

https/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <enrollments>
        <enrollment>
            <enrollmentId>c9c6bc26-f593-11e9-a66a-0a580af40186</enrollmentId>
            <courseId>c74a4369-f593-11e9-a66a-0a580af40186</courseId>
            <learnerId>b698163c-f593-11e9-a66a-0a580af40186</learnerId>
            <accessDate>2018-03-07</accessDate>
            <shouldLockAfterDueDate>0</shouldLockAfterDueDate>
            <certificate>
                <issuedCertificateId>66b4ed00-040e-11ed-a8a2-b6f58d6fa7b5</issuedCertificateId>
                <issueDate>2022-07-15T07:19:00+00:00</issueDate>
                <expiryDate>2022-07-15T07:21:00+00:00</expiryDate>
            </certificate>
        </enrollment>
        <enrollment>
            ...
        </enrollment>
    </enrollments>
    <nextPageToken>string</nextPageToken>
</response>