Примеры использования открытого API

Пример 1

Метод вернет ошибку или ссылку для доступа пользователя на портал пользователя в случае, если для этого пользователя ранее уже было запущено обучение.

Если вернулась ссылка, ее следует отобразить пользователю и на этом вызов дальнейших методов прекращается.

Во всех других случаях будет возвращена ошибка с разными кодами, список доступных кодов описан в Swagger и онлайн-документации.

При получении ошибки 404 user-not-found происходит переход к вызову метода #2.

Любая ошибка с кодом 422 предполагает, что в настоящий момент идет расчет обучения и ссылка скоро появится. Если этого не происходит, то следует связаться с администратором аккаунта для которого был выписан API-токен в ASAP.

Пример 2

На этом этапе идет получение списка групп в которые может себя добавить пользователь. Необходимо после получения метода произвести фильтрацию, чтобы отображались только те группы, для которых параметру isStarted соответствует значение true.

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

Если нет не одной группы, вернется ошибка 404 groups-not-found. В этом случае следует связаться с администратором аккаунта для которого был выписан API-токен в ASAP.

Пример 3

После выбора группы персональные данные и идентификатор группы передаются на метод #3. В результате будет получен ответ 201 с идентификатором добавленного пользователя или ошибка. В случае ошибки следует связаться с администратором аккаунта для которого был выписан api-токен в ASAP.

Пример 4

Для получения отчетных данных по обучению сотрудников:

1. Адрес электронной почты, с которым зарегистрирован пользователь.
2. Краткое имя пользователя, с которым пользователь зарегистрирован в системе.
3. Полное имя пользователя, с которым пользователь зарегистрирован в системе.
4. Текущая группа, в которой пользователь проходит обучение.
5. Длительность обучения в секундах.
6. Категория успеваемости в основном курсе.
7. Категория успеваемости в экспресс-курсе.
8. Текущий статус обучения.
9. Прогресс обучения в процентах в основном курсе в формате хх.хх.
10. Прогресс обучения в процентах в экспресс-курсе в формате хх.хх.
11. Плановая дата завершения прохождения основного курса.
12. Плановая дата завершения прохождения экспресс-курса.
13. Дата завершения основного курса.
14. Дата завершения экспресс-курса.
15. Курсы обучения и статус обучения в основном курсе.
16. Курсы обучения и статус обучения в экспресс-курсе.
17. Дата последней активности в формате, зависящей от переданного на вход языка локализации.
18. Общее количество сертификатов, полученных пользователем за время обучения.

Пример 5

Для перемещения пользователей между группами и формирования данных по группе обучения для каждого конкретного сотрудника компании:

1. Текущая группа обучения;
2. Предыдущая группа обучения.

Пример 6

Удаление сотрудника из системы ASAP.