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

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

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

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

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

ID пользователей, результаты которых вы хотите получить
courseIds (необязательный)ID курсов, результаты по которым вы хотите получить
moduleIds (необязательный)ID материалов, результаты по которым вы хотите получить
courseItemIds (необязательный)ID материалов, результаты по которым вы хотите получить
enrollmentIds (необязательный)ID назначений, информацию о которых хотите получить

accessDate[startDate], accessDate[endDate] (необязательный)

Выборка по дате начала обучения. Можно указать только accessDate[startDate] или accessDate[endDate]
dueDate[startDate], dueDate[endDate] (необязательный)Выборка по по сроку выполнения курсов. Можно указать только dueDate[startDate] или dueDate[endDate]
completionDate[startDate], completionDate[endDate] (необязательный)

Выборка по дате завершения курсов пользователями. Можно указать только completionDate[startDate] или completionDate[endDate]

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

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

  • not_started,
  • in_progress,
  • pending,
  • complete,
  • passed,
  • accepted,
  • incomplete,
  • failed,
  • declined
departmentIds  (необязательный)ID подразделений, результаты которых вы хотите получить
userStatuses (необязательный)

Статус пользователей.

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

1 — активный,

3 — заблокированный.

По умолчанию, в ответе выводятся данные по активным пользователям

pageSize (необязательный)Количество записей на 1 страницу. Если не указан, то 1000
pageToken (необязательный)Токен для перехода на следующую страницу выборки. Не указывается для первой страницы

...

Блок кода
languagexml
https/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <results>
        <result>
            <userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
            <courseId>1852f94e-a75e-11eb-92c3-0242ac13002a</courseId>
            <courseTitle>Course 1</courseTitle>
            <moduleId>5a98720f-41e2-11ea-8a66-0a580af40c6f</moduleId>
            <courseItemId>553964ac-3c5c-11ef-b1c4-02420a200163</courseItemId>                                                        
            <enrollmentId>b9b41af0-f062-11eb-a99d-0242ac190033</enrollmentId>
            <accessDate>2021-07-28T21:00:00+00:00</accessDate>
            <timeSpent>10</timeSpent>
            <completionStatus>in_progress</completionStatus>
            <progress>9.09</progress>
            <isOverdue>0</isOverdue>
        </result>
        <result>
            <userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
            <courseId>9d73e408-a821-11eb-b84b-0242ac14002a</courseId>
            <courseTitle>Course 2</courseTitle>
            <moduleId>55e716fa-3c5c-11ef-96f2-02420a200177</moduleId>
            <courseItemId>65a773eb-3c5c-11ef-b1c4-02420a200163</courseItemId>
            <enrollmentId>bc2b7f9a-f066-11eb-bfc4-0242ac190033</enrollmentId>
            <accessDate>2021-07-28T21:00:00+00:00</accessDate>
            <dueDate>2021-07-29T21:00:00+00:00</dueDate>
            <expirationDate>2021-07-29T21:00:00+00:00</expirationDate>
            <timeSpent>0</timeSpent>
            <completionStatus>in_progress</completionStatus>
            <progress>50</progress>
            <isOverdue>1</isOverdue>
        </result>
        <result>
            <userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
            <courseId>401df18c-f37f-11eb-a842-0242ac130033</courseId>
            <courseTitle>Course 3</courseTitle>
            <moduleId>6657451e-3c5c-11ef-ae43-02420a200177</moduleId>
            <courseItemId>81fdb5be-3c5c-11ef-9bec-02420a200177</courseItemId>
            <enrollmentId>b44e7392-f389-11eb-b462-0242ac130033</enrollmentId>
            <accessDate>2021-08-01T21:00:00+00:00</accessDate>
            <dueDate>2021-08-03T21:00:00+00:00</dueDate>
            <timeSpent>0</timeSpent>
            <completionStatus>not_started</completionStatus>
            <isOverdue>1</isOverdue>
        </result>
    </results>
</response>

...