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

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

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

Запрос

Заголовок:

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

Тело:

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

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

Язык	Значение lng
English	en
Bosanski	bs
Català	ca
Čeština	cs
Dansk	da
Deutsch	de
Ελληνικά	el
Español (España)	es
Еspañol (México)	mx
Français	fr
Hrvatski	hr
Italiano	it
Қазақша	kk
Magyar	hu
Nederlands	nl
Polski	pl
Português (Brasil)	br
Português (Portugal)	pt
Română	ro
Русский	ru
Slovenski	sk
Srpski	sr
Svenska	sv
Türkçe	tr
العربية	ar
日本語	ja
漢語	zh

• email – тип array – адрес электронной почты пользователя. Указывается для получения данных по конкретному пользователю. Не обязателен к заполнению.

  Требования к указываемым адресам: 1) введен маленькими буквами, 2) содержит спец символы "@" и ".".

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

Ответ

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 – курсы обучения и статус обучения в основном курсе.

  Формат ответа:

  [

  {

  code,

  level,

  status,

  startedAt,

  finishedAt

  }

  ]

  где:

  • code – наименование курса в зависимости от языка локализации.
  • level – уровень обучения. Может принимать следующие значения:
    • 1 – "Начальный".
    • 2 – "Элементарный".
    • 3 – "Средний".
    • 4 – "Продвинутый".
  • status – статус обучения на курсе. Может принимать следующие значения:
    • 0 – "Назначен". Курс доступен для прохождения в рамках текущего индивидуального пути обучения сотрудника. Курс будет доступен для прохождения после завершения текущего модуля/начала обучения.
    • 1 – "Пройденные". Получен сертификат о прохождении обучения.
    • 2 – "В процессе прохождения". Курс проходится в рамках текущего индивидуального пути обучения сотрудника.
  • startedAt – дата и время начала обучения на модуле, формируется в формате ISO 8601 YYYY-MM-DDThh:mm:ss. Формат даты YYYY-MM-DD - зависит от переданного на вход языка.
  • finishedAt – дата и время окончания обучения на модуле (получения сертификата), формируется в формате ISO 8601 YYYY-MM-DDThh:mm:ss. Формат даты YYYY-MM-DD зависит от переданного на вход языка. Если данные отсутствуют, возвращается пустое значение.

  Если данных нет, формируется пустой массив.

• educationExpressCourses – тип array – курсы обучения и статус обучения в экспресс-курсе.

  Формат ответа:

  [

  {

  code,

  level,

  status,

  startedAt,

  finishedAt

  }

  ]

  где:

  • code – наименование курса в зависимости от языка локализации.
  • level – уровень обучения.
  • status – статус обучения на курсе. Может принимать следующие значения:
    • 0 – "Назначен". Курс доступен для прохождения в рамках текущего индивидуального пути обучения сотрудника.
    • 1 – "Пройденные".

    Для текущего обучения производится проверка: включены ли прохождение тестов. Если тесты включены и по модулю есть успешно сданный тест или если тесты выключены и есть отметка о получении навыка, тогда "status": 1. В противном случае "status": 0.

  • startedAt – дата и время начала обучения на модуле, формируется в формате ISO 8601 YYYY-MM-DDThh:mm:ss. Формат даты YYYY-MM-DD - зависит от переданного на вход языка.
  • finishedAt – дата и время окончания обучения на модуле (получения сертификата), формируется в формате ISO 8601 YYYY-MM-DDThh:mm:ss. Формат даты YYYY-MM-DD зависит от переданного на вход языка. Если данные отсутствуют, возвращается пустое значение.

  Если данных нет, формируется пустой массив.

• dateLastActive – тип date – дата последней активности в формате, зависящей от переданного на вход языка локализации.
• certificatesReceived – тип int – общее количество сертификатов, полученных пользователем за время обучения.

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

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

  Формат ответа:

  [

  {

  code: '''',

  level: '''', 

  startedAt: '''', 

  phishingAttackLetter: '''', 

  phishingAttackResult: '''',

  followPhishingLinkAt: ''" || null

  }

  ]

  где:

  • code – наименование обучающего модуля, в рамках которого отправлено фишинговое письмо, в зависимости от языка локализации.
  • level – уровень обучения. Может принимать следующие значения:
    • 1 – "Начальный".
    • 2 – "Элементарный".
    • 3 – "Средний".
    • 4 – "Продвинутый".

    Для фишинговых писем, отправленных в рамках фишинговой кампании, возвращается пустое значение.

  • startedAt – дата и время начала обучения на модуле, формируется в формате ISO 8601 YYYY-MM-DDThh:mm:ss. Формат даты YYYY-MM-DD - зависит от переданного на вход языка.
  • phishingAttackLetter – название фишингового письма. При рассылке фишинговых писем по шаблону используется название, введенное администратором. Название зависит от поданного на вход языка локализации.
  • phishingAttackLetter – результат фишинговой атаки. Может принимать следующие значения:
    • 0 – фишинговое письмо отправлено. Ожидается реакция пользователя.
    • 1 – пользователь избежал фишинговой атаки.
    • 2 – пользователь попался на фишинг.
  • followPhishingLinkAt – дата и время перехода по фишинговой ссылке. Формируется только для "phishingAttackResult": 2, в остальных случаях возвращается пустое значение.  

  Если данных нет, формируется пустой массив.

Пример ответа: { "idl":"60e050803050c0704080a0e060", "email":"jackrockstar88@email.com", "shortName":"Jack", "fullName":"Jack Rock", "group":"Low Risk", "educationTime":"00:14:00", "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", "educationCourses": [ {   code: 'Password',   level: 1 || null,   status: 'Open' || 'passed'   startedAt: ''    finishedAt: '' || null,   } ], "dateLastActive":"2022-08-08", "certificatesReceived":2 } "phishingAttack":  [ { 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 – внутренняя ошибка сервера.

В начало