API. Выгрузка данных о прохождении форм

GET /userapi/eventsessions/{eventSessionId}/form-passing/export

МЕТОД HTTP

GET

URL

https://userapi.mts-link.ru/v3/eventsessions/{eventSessionId}/form-passing/export


ОПИСАНИЕ

Метод выгружает ответы на форму, которую участники заполняли ради сертификата, — ту, что указана в условии выдачи «Заполнить форму» в настройках сертификата мероприятия. Ответы на форму, запущенную в эфире через меню «Инструменты», этим методом не выгружаются, их можно выгрузить из личного кабинета, см. «Возможность выгрузки результатов формы в файл» (https://help.mts-link.ru/article/24170).

Если у мероприятия не включены сертификаты или в условиях выдачи не указана форма, метод вернёт 404.

ОБЯЗАТЕЛЬНЫЕ ПАРАМЕТРЫ

  • eventSessionId — ID сессии мероприятия (передается в path).

ДОПОЛНИТЕЛЬНЫЕ ПАРАМЕТРЫ

нет

ПОЛЯ ОТВЕТА

  • certificateId — Уникальный номер сертификата.
  • sessionId — Идентификатор мероприятия (SessionID).
  • formId — Идентификатор формы.
  • participantId — Идентификатор участника (participantID).
  • formUrl — Ссылка на форму участника.
  • answers — Объект с ответами участника на форму.

ПРИМЕР ЗАПРОСА


GET https://<host>/api/userapi/eventsessions/{eventSessionId}/form-passing/export
X-Auth-Token: <your_api_key>


ПРИМЕР ОТВЕТА


200 - Успешно

{
  "data": [
    {
      "certificateId": "CERT-1234567890",
      "sessionId": 123456,
      "formId": 789,
      "participantId": 456789,
      "formUrl": "https://<host>/form/...",
      "answers": {
        "fullName": "Иванов Иван Иванович",
        "organization": "ООО Пример",
        "customField1": "Значение 1"
      }
    }
  ]
}
👆 На этом пока всё