История страницы

Запрос: GET /learners/results

Заголовки

Параметр	Описание
X-Auth-Account-Url (обязательный)	Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru.
X-Auth-Email (обязательный)	Логин Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора

или пользователя с ролью с индивидуальными настройками.
X-Auth-Password (обязательный)	Пароль Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора

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

Параметры

learnerIds

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

ID пользователей,

список назначений

результаты которых вы хотите получить.
courseIds (необязательный)	ID курсов, результаты по которым вы хотите получить. Результаты по материалам, которые включены в составной курс, в рамках данного метода получить нельзя.
accessDate[startDate], accessDate[endDate] (необязательный)	Начальное и конечное ограничение по дате назначения курсов. Параметр может иметь только одну границу.
dueDate[startDate], dueDate[endDate] (необязательный)	Начальное и конечное ограничение по сроку выполнения курсов. Параметр может иметь только одну границу.
completionDate[startDate], completionDate[endDate] (необязательный)	Начальное и конечное ограничение по дате завершения курсов. Параметр может иметь только одну границу.
completionStatuses (необязательный)

ID материалов, список назначений

Статус прохождения курсов, результаты по которым вы хотите получить. Возможные значения — not_started, in_progress, pending, complete, passed, accepted, incomplete, failed, declined.
departmentIds (необязательный)	ID подразделений, результаты которых вы хотите получить.
userStatuses (необязательный)	Статус пользователей. Может принимать следующие значения: 1 — активный, 3 — заблокированный. По умолчанию, в ответе выводятся данные по активным пользователям.
pageSize (необязательный)	Количество записей на 1 страницу. Если не указан, то 1000.
pageToken (необязательный)	Токен для перехода на следующую страницу выборки. Не указывается для первой страницы.

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

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

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

После того как запрос был успешно обработан, отправляется код ответа 200. Тело ответа будет содержать данные с информацией о результатах пользователей в xml.

Коды ответов

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

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

Блок кода

language	xml

GET/learners/results?userIds[]=85077abc-2639-11ea-8e3f-0a580af40c09&courseIds[]=f0e7400a-ca31-11e9-b6fc-0a580af40a22&accessDate[startDate]=2019-12-24T21:00:00Z&accessDate[endDate]=2020-12-30T03:00:00Z&dueDate[startDate]=2019-08-30T03:00:00Z&dueDate[endDate]=2019-12-30T03:00:00Z&completionDate[startDate]=2019-08-30T03:00:00Z&completionDate[endDate]=2019-12-30T03:00:00Z&completionStatus=failed&departmentIds[]=f0b2d3c0-aded-11e9-bfe6-0a580af40906&userStatuses[]=1&pageSize=33&pageToken=MmEzZTBiMjAtYmNmYi0xMWU5LTk2ODUtMGE1ODBhZjQwOTVj

HTTP/1.1
Host: api-learn.ispringlearn.ru
X-Auth-Account-Url: http://my.ispringlearn.ru
X-Auth-Email: email@email.com
X-Auth-Password: password

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

Блок кода

language	xml

HTTP/1.1 200 Successful operation
Connection: close
 
<?xml version="1.0" encoding="UTF-8"?>
<response>
     <ListLearnersResultsResult>
         <learnersResults>
             <learnerResult>
               <userId>6b0dfde6-9e69-11e9-8e2c-0a580af404f9</userId>
               <courseId>e1175540-ae0f-11e9-b49e-0a580af405b3</courseId>
               <courseTitle>КУРС 1</courseTitle>
               <enrollmentId>1777fdf0-232d-11ea-a24a-0a580af40c27</enrollmentId>
               <accessDate>2019-12-25T01:00:00+00:00</accessDate>
               <dueDate>2019-12-27T21:00:00+00:00</dueDate>
               <expirationDate>2019-12-27T21:00:00+00:00</expirationDate>
               <completionStatus>not_started</completionStatus>
               <isOverdue>true</isOverdue>
            </learnerResult>
            <learnerResult>
               <userId>1529eee6-adee-11e9-a5d9-0a580af40906</userId>
               <courseId>9789a1ec-adee-11e9-b1b5-0a580af40906</courseId>
               <courseTitle>КУРС 2</courseTitle>
               <enrollmentId>a2cadee0-adee-11e9-b31d-0a580af40909</enrollmentId>
               <accessDate>2019-07-24T00:00:00+00:00</accessDate>
               <timeSpent>127</timeSpent>
               <completionStatus>in_progress</completionStatus>
               <awardedScore>13.64</awardedScore>
               <isOverdue>false</isOverdue>
               <viewsCount>2</viewsCount>
            </learnerResult>
            <learnerResult>
               <userId>0569aad2-adee-11e9-b6c5-0a580af40906</userId>
               <courseId>1b70b088-ae06-11e9-b7d8-0a580af405b3</courseId>
               <courseTitle>КУРС 3</courseTitle>
               <enrollmentId>3d4776b0-ae06-11e9-9707-0a580af4013b</enrollmentId>
               <accessDate>2019-07-24T00:00:00+00:00</accessDate>
               <completionDate>2019-07-24T11:30:07+00:00</completionDate>
               <timeSpent>41006</timeSpent>
               <completionStatus>complete</completionStatus>
               <isOverdue>false</isOverdue>
               <viewsCount>3</viewsCount>
            </learnerResult>             
            <learnerResult>
               <userId>1529eee6-adee-11e9-a5d9-0a580af40906</userId>
               <courseId>1a6bc896-aec2-11e9-8955-0a580af406a3</courseId>
               <courseTitle>КУРС 4</courseTitle>
               <enrollmentId>296bdbd8-aec2-11e9-aee5-0a580af402ea</enrollmentId>
               <accessDate>2019-07-25T00:00:00+00:00</accessDate>
               <completionDate>2019-07-25T09:55:37+00:00</completionDate>
               <timeSpent>37</timeSpent>
               <completionStatus>complete</completionStatus>
               <isOverdue>false</isOverdue>
               <viewsCount>2</viewsCount>
            </learnerResult>
            </learnersResults>
         <nextPageToken>MGJiYjhlZGMtMjcwMS0xMWVhLTljYzgtMGE1ODBhZjQwYzRm</nextPageToken>
      </ListLearnersResultsResult>
</response>

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

Сравнение версий

Старая версия 2

Новая версия 3

Ключ