Взаимодействие площадок по API
Эндпоинт для отправки запросов: Схема - POST https://api.migrant-exam.ru/Reports/Report
Принимает content-type "application/json" со схемой:
{
"reportId" : 1 (integer) (Необязательное поле, передается в том случае, если надо заменить ранее отправленный отчет)
"examinationAreaId": 1 (integer) (Идентификатор площадки, предоставляется индивидуально каждой организации),
"periodStartDate": "2025-05-26" (string) (Дата начала отчетного периода. Должен быть обязательно понедельник),
"periodEndDate": "2025-06-01" (string) (Дата окончания отчетного периода. Должно быть обязательно воскресенье этой же недели, что и Дата начала отчетного периода),
"noExamInSelectedPeriod": false (boolean true/false) (Если за выбранный промежуток не проводились экзамены - передается в значении True, иначе - False),
"examinationAreaDoesNotWork": false (boolean true/false) (Указывается в том, случае, если на текущий момент площадка не работает и в ближайшее время экзамены проводиться не будут),
"patentNearestStartDate": "2025-07-05" (string) (Ближайшая дата старта экзамена с уровнем Патент/Разрешение на работу. Не передается, если были переданы параметры "examinationAreaDoesNotWork" или "noPatentExamType" в значении True),
"noPatentExamType": false (boolean true/false) (Показывает, что в ближайшее время не будет экзаменов с уровнем Патент/Разрешение на работу. Не передается, если был передан параметр "examinationAreaDoesNotWork" в значении True),
"temporaryResidenceNearestStartDate": "2025-07-10" (string) (Ближайшая дата старта экзамена с уровнем РВП. Не передается, если были переданы параметры "examinationAreaDoesNotWork" или "noPatentExamType" в значении True),
"noTemporaryResidenceExamType": false (boolean true/false) (Показывает, что в ближайшее время не будет экзаменов с уровнем РВП. Не передается, если был передан параметр "examinationAreaDoesNotWork" в значении True),
"residencePermitNearestStartDate": "2025-07-15" (string) (Ближайшая дата старта экзамена с уровнем ВНЖ. Не передается, если были переданы параметры "examinationAreaDoesNotWork" или "noPatentExamType" в значении True),
"noResidencePermitExamType": false (boolean true/false) (Показывает, что в ближайшее время не будет экзаменов с уровнем ВНЖ. Не передается, если был передан параметр "examinationAreaDoesNotWork" в значении True),
"comment": "Отчет по экзаменационной площадке за июнь 2025 года" (string) (Необязательное поле, просто как пометка к отчету),
"requests": [
{
"identityDocumentNumber" : "blablabla" (string) (Закодированный/зашифрованный номер документа сдающего),
"examDate" : "2025-05-28" (string) (Дата проведения экзамена),
"migrationExamType" : 1 (integer) (Уровень экзамена. Список значений указан ниже),
"migrationExamStatus": 1 (integer) (Статус сдачи экзамена. Список значений указан ниже)
} (array) (Коллекция заявок, которые проходили экзамены за указанный период. Не указываются в том случае, если был передан параметр "noExamInSelectedPeriod" в значении True)
]
}
Возможные значения migrationExamType:
1 - Патент/Разрешение на работу
2 - РВП
3 - ВНЖ
Возможные значения migrationExamStatus:
1 - Сдал
2 - Не сдал
В случае успешного приема и записи данных по API, в ответ будет возвращен статус OK (200) с телом ответа JSON вида:
{
"reportId": 1 (integer) (Идентификатор созданного отчета)
}
Если была передана некорректная модель данных JSON (не заполнены обязательные поля),
то будет возвращен статус BadRequest (400), в котором в теле ответа будет JSON с ошибками.
Например:
{
"errors": {
"NoExamInSelectedPeriod": [
"Поле обязательно для заполнения"
]
},
}
Если какие-либо переданные параметры не прошли валидацию,
то также вернется статус BadRequest (400) с JSON в теле ответа вида:
{
"error" : "Описание ошибки" (string) (Здесь могут быть различные ошибки, например, не была передана коллекция заявок за указанный период без выставления параметра "noExamInSelectedPeriod" в значении True)
}
Last updated