Метод POST /openapi/v1/report

Сформировать отчетные данные по пользователям, зарегистрированным на портале и проходящим обучение по программам ASAP.

Объем передаваемых данных описан в разделе о теле запроса.

Запрос

Заголовок:

• Authorization – API-токен компании.

Тело:

• lng – тип string – код языка, на котором формируется отчет. Соответствует доступным языкам локализации в формате ISO 639-1. Обязателен к заполнению. Заполняется строчными буквами.

  Соответствие языка формирования отчета и значения lng

  Язык	Код языка / название подпапки
  English	en
  Bahasa Indonesia	id
  Bosanski	bs
  Català	ca
  Čeština	cs
  Dansk	da
  Deutsch	de
  Ελληνικά	el
  Español (España)	es
  Español (México)	mx
  Français	fr
  Հայերեն	hy
  Hrvatski	hr
  Italiano	it
  Қазақша	kk
  Magyar	hu
  Nederlands	nl
  Polski	pl
  Português (Brasil)	br
  Português (Portugal)	pt
  Română	ro
  Русский	ru
  Slovenski	sl
  Slovenský	sk
  Srpski	sr
  Svenska	sv
  Tiếng Việt	vi
  Türkçe	tr
  العربية	ar
  ไทย	th
  日本語	ja
  简体中文	cn
  繁體中文（香港）	zh

• email – тип array – адрес электронной почты пользователя. Указывается для получения данных по конкретному пользователю. Не обязателен к заполнению.
• page – тип int – номер страницы с отчетом. При обращении к API в ответе выводится не более 500 записей, и, если пользователей в запрашиваемом отчете больше, то для просмотра записей сверх пятисотой необходимо дополнительно указать страницу отчета. Не обязателен к заполнению.

  Например, чтобы посмотреть 501-ю запись отчета, следует задать параметр "page": 2.

Пример тела запроса: {     "lng":"en",     "email":["example@email.com","jackrockstar88@email.com"],     "page":1 }

Ответ

JSON с массивом данных по каждому пользователю:

• id – тип string – ID сотрудника, присвоенный ему на платформе ASAP.
• email – тип string – адрес электронной почты, с которым зарегистрирован пользователь.
• shortName – тип string – краткое имя пользователя, с которым пользователь зарегистрирован в системе.
• fullName – тип string – полное имя пользователя, с которым пользователь зарегистрирован в системе.
• group – тип string – текущая группа, в которой пользователь проходит обучение.
• educationTime – тип string – длительность обучения в секундах.
• mainEducationProgress – тип string – категория успеваемости в основном курсе.
• expressEducationProgress – тип string – категория успеваемости в экспресс-курсе.
• educationStatus – тип string – текущий статус обучения.
• mainEducationProgressPercent – тип float – прогресс обучения в процентах в основном курсе в формате хх.хх.
• expressEducationProgressPercent – тип float – прогресс обучения в процентах в экспресс-курсе в формате хх.хх.
• mainEducationEndPlan – тип date – плановая дата завершения прохождения основного курса.
• expressEducationEndPlan – тип date – плановая дата завершения прохождения экспресс-курса.
• realMainEducationEnd – тип date – дата завершения основного курса.
• realExpressEducationEnd – тип date – дата завершения экспресс-курса.
• educationMainCourses – тип array – курсы обучения и статус обучения в основном курсе. Формат ответа.
• educationExpressCourses – тип array – курсы обучения и статус обучения в экспресс-курсе. Формат ответа.
• dateLastActive – тип date – дата последней активности в формате, зависящей от переданного на вход языка локализации.
• certificatesReceived – тип int – общее количество сертификатов, полученных пользователем за время обучения.

  Если пользователь не начинал обучение или им не было получено ни одного сертификата, возвращается "0".

• phishingAttacks – тип array – данные о фишинговой атаке во время обучения на платформе ASAP. Формат ответа.

Пример ответа: { "id":"60e050803050c0704080a0e060", "email":"jackrockstar88@email.com", "shortName":"Jack", "fullName":"Jack Rock", "group":"Low Risk", "educationTime":840, "mainEducationProgress":"Behind schedule", "expressEducationProgress":"In progress", "educationStatus":"not started", "mainEducationProgressPercent":"50.00", "expressEducationProgressPercent":"14.80", "mainEducationEndPlan":"2022-08-08", "expressEducationEndPlan":"0001-01-01", "realMainEducationEnd":"0001-01-01", "realExpressEducationEnd":"0001-01-01", "educationMainCourses": [   {   code: 'Password',   level: 1 || null,   status: 0 || 1 || 2   startedAt: ''   finishedAt: '' || null,   } ], "educationExpressCourses": [   {   code: 'Password',   level: 1 || null,   status: 0 || 1 || 2   startedAt: ''   finishedAt: '' || null,   } ], "dateLastActive":"2022-08-08", "certificatesReceived":2, "phishingAttacks": [   {   code: 'Password',   level: 1   startedAt: '2022-09-09T18.00.00.0Z',   phishingAttackLetter: 'Hallo!',   phishingAttackResult: '0',   followPhishingLinkAt: null } ] }

Возможные ошибки

• 200 – successful – корректное завершение работы.
• 401 – common-unauthorized – ошибка авторизации.
• 404 – user not found – передан неверный адрес электронной почты.
• 400 – bad request – недопустимый запрос.
• 500 – internal-server-error – внутренняя ошибка сервера.

В этом разделе Формат объекта educationMainCourses Формат объекта educationExpressCourses Формат объекта phishingAttacks

В начало