Запрос
Адрес запроса
| POST: {{url}}/mipdental-regsapi/api/minsoclg?mkabGuid={mkabGuid}&&snils={snils}®isterGuid={registerGuid}NeedLzp |
Заголовки запроса
| Параметр | Описание | Обязательный | Комментарий | ||
|---|---|---|---|---|---|
| Authorization | Идентификатор приложения-клиента | + | |||
| Content-Type | application/json | + | Ticket | токен авторизации | + |
...
Тело запроса
| Параметр | Тип | Тип данных | Описание | По умолчанию | Обязательный | Комментарий |
|---|---|---|---|---|---|---|
| snils | query | string | СНИЛС пациента |
| - | ||||||
| mkabGuid | query | string(Guid) | Идентификатор пациента | + | ||
| registerGuid | query | string(Guid) | Идентификатор записи в регистре | + |
Тело запроса
| Тип | Тип данных | Описание | По умолчанию | Обязательный | Комментарий | ||||
|---|---|---|---|---|---|---|---|---|---|
| statement | query | bool | Статус заявления на ЛЗП | + | Если true то все поля ответа обязательны, если false то необязательны | ||||
| comment | query | string | Причина отказа по заявлению | - | Комментарий с причиной отказа | ||||
| katlCode | query | string | Код категории льготы | +/- | метод получения списка справочника категорий льгот | ||||
| katlDocumentSeries | query | string | Серия документа, подтверждающего | документакатегорию льготы | +/- | ||||
| documentNumberkatlDocumentNumber | query | string | Номер документа, подтверждающего документакатегорию льготы | - | |||||
| documentIssuedBykatlDocumentIssuedBy | query | string | Кем выдан документ, подтверждающий документкатегорию льготы | +/- | |||||
| documentDatekatlDocumentDate | query | string | Дата выдачи документа, подтверждающего категорию льготы | +/- | |||||
| katlDocumentBase | query | string | Тип документа, подтверждающего категорию льготы | +/- | Справка | ||||
| katlDateBegin | query | string | Дата начала действия категории льготы | +/- | Формат: yyyy-MM-dd | ||||
| katlDateEnd | query | string | Дата окончания действия категории льготы | - | Формат: yyyy-MM-dddocumentBase | ||||
| lgCode | query | string | Код льготы | +/- | Для ЛЗП необходимо передавать код "5" (Зубные протезы) | ||||
| lgDocumentSeries | query | string | Тип подтверждающего документа | +/- | 1 - Справка 2 - Документ 3 - Удостоверение 4 - Иной документ | Серия документа, подтверждающего льготу | +/- | ||
| lgDocumentNumber | query | string | Номер документа, подтверждающего льготу | - | |||||
| lgDocumentIssuedBy | query | string | Кем выдан документ, подтверждающий льготу | +/- | |||||
| lgDocumentDate | query | string | Дата выдачи документа, подтверждающего льготу | +/- | Формат: yyyy-MM-dd | ||||
| lgDocumentBase | query | string | Тип документа, подтверждающего льготу | +/- | Справка | ||||
| lgDateBegindateBegin | query | string | Дата начала действия льготы | +/- | Формат: yyyy-MM-dd | ||||
| dateEndlgDateEnd | query | string | Дата окончания действия льготы | - | Формат: yyyy-MM-dd |
Ответ сервера
В случае успешного выполнения вернется статус 200 -– ОК
В случае возникновения ошибок в поле Errors вернётся массив с ошибкамиошибок вернётся объект ProblemDetails,
где title – текст ошибки, status – код ошибки
Пример ответа сервера при возникновении ошибки:
| Блок кода |
|---|
{
"title": "Неверно указаны параметры пациента",
"status": 400
} |
Возможные ошибки
Код ответа сервера | Сообщение | Описание ошибки | Тип ошибки |
|---|---|---|---|
| 401 | Не указан токен | Системная ошибка выполнения запроса | Error |
| 401 | Неверный формат токена | Системная ошибка выполнения запроса | Error |
| 401 | Указан неверный токен | Системная ошибка выполнения запроса | Error |
| 400 | Неверно указаны параметры пациента | Неверно переданы параметры Snils, MkabGuid в теле запроса | Error |
| 400 | Неверно указаны параметры записи о регистре | Неверно передан RegisterGuid в теле запроса | Error |
| 400 | Неверно указаны параметры льготы | Неверно переданы параметры льготы в теле запроса | Error |
| 400 | Не найдена запись о пациенте в регистре | По переданному идентификатору RegisterGuid пациент не найден в регистре | Error |
| 400 | Пациент уже включен в регистр | убрать (неактуально) | Error |
| 400 | Не удалось найти пациента по указанным параметрам | По переданному Snils, MkabGuid не найден пациент. | Error |
| 400 | Указана некорректная категория льготы | Переданная категория льготы не соответствует разрешенному списку категорий в НПА | Error |
| 500 | Пациент уже имеет указанную льготу | убрать (неактуально) | Error |
| 500 | Не найдена запись о льготе пациента | убрать (неактуально) | Error |
| 500 | Не найдена мера соц. поддержки по льготе | убрать (неактуально) | Error |
| 500 | У пациента уже добавлена мера соц. поддержки по льготе с указанными данными | убрать (неактуально) | Error |