Запрос
Адрес запроса
GETPOST: {{url}}/dentalprosthetics/privilege?ss={ss}&surname={surname}&name={name}&patronymic={patronymic}&birthday={birthday}&doctype={doctype}&docname={docname}&docseries={docseries}&docnumber={docnumber}&docdate={docdate}&docissuedby={docissuedby}&address={address} |
Параметры запроса
/dental-api/api/NeedLzp |
Заголовки запроса
Параметр | Описание | Обязательный | Комментарий |
---|---|---|---|
Authorization | Идентификатор приложения-клиента | + | |
Content-Type | application/json | + |
Тело запроса
Параметр | Тип | Тип данных |
---|
Описание | По умолчанию | Обязательный | Комментарий |
---|
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 | Серия документа, подтверждающего категорию льготы | +/- | ||
katlDocumentNumber | query | string | Номер документа, подтверждающего категорию льготы | - | ||
katlDocumentIssuedBy | query | string | Кем выдан документ, подтверждающий категорию льготы | +/- | ||
katlDocumentDate | query | string | Дата выдачи документа, подтверждающего категорию льготы | +/- | ||
katlDocumentBase | query | string | Тип документа, подтверждающего категорию льготы | +/- | Справка | |
katlDateBegin | query | string | Дата начала действия категории льготы | +/- |
Формат: yyyy-MM-dd |
katlDateEnd | query |
Документ удостоверяющий личность - IdentityDocument
string | Дата окончания действия категории льготы | - | Формат: yyyy-MM-dd | |||
lgCode | query | string | Код льготы | +/- | Для ЛЗП необходимо передавать код "5" (Зубные протезы) | |
lgDocumentSeries | query | string | Серия документа, подтверждающего льготу | +/- | ||
lgDocumentNumber | query | string | Номер документа, подтверждающего льготу | - | ||
lgDocumentIssuedBy | query | string | Кем выдан документ, подтверждающий льготу | +/- | ||
lgDocumentDate | query | string | Дата выдачи документа, подтверждающего льготу | +/- |
Формат: yyyy-MM-dd |
lgDocumentBase | query |
Ответ сервера
Ответ возвращается в виде объекта результата операции, где
В случае успешного выполнения в поле Data вернётся объект в формате JSON со следующими данными:
Модель:
...
Блок кода |
---|
{
"isProActive": false,
"socDepartmentName": "Управление социальной защиты населения",
"authorizedPerson": {
"surname": "Иванов",
"name": "Иван",
"patronymic": "Иванович",
}
"privilegeType": {
"code": "36",
"name": "Ветераны труда"
},
"patient": {
"ss": "222-222-222 22",
"surname": "Петров",
"name": "Петр",
"patronymic": "Петрович",
"birthday": "2043-01-01",
"document": {
"docType": "14",
"docName": "Паспорт РФ",
"series": "99 99",
"number": "735284",
"date": "2018-01-01",
"docissuedby": "Отделением №1 ОУФМС России"
},
"address": "Московская обл.,Химки г.,Ленинский пр-кт.,23",
},
"number": "0010001",
"date": "2019-11-30T17:40:22.4018297+03:00"
} |
...
isProActive
...
socDepartmentName
...
authorizedPerson
...
privilegeType
...
patient
...
number
...
date
...
string | Тип документа, подтверждающего льготу | +/- | Справка | |||
lgDateBegin | query | string | Дата начала действия льготы | +/- | Формат: yyyy-MM-dd | |
lgDateEnd | query | string | Дата окончания действия льготы | - | Формат: yyyy-MM-dd |
Ответ сервера
В случае успешного выполнения вернется статус 200 – ОК
В случае возникновения ошибок вернётся объект 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 |
...