## Документация API ФССП алименты

### Поиск информации о задолженности по алиментам

Для поиска информации о задолженности по алиментам в реестре Федеральной службы судебных приставов используйте следующий запрос:

```
https://service.api-assist.com/parser/fssp_alim_api/?key=ВАШ_КЛЮЧ_ДОСТУПА&lastName=ФАМИЛИЯ&firstName=ИМЯ&patronymic=ОТЧЕСТВО&dob=ДАТА_РОЖДЕНИЯ&regionID=КОД_РЕГИОНА&page=СТРАНИЦА
```

**Параметры запроса:**

- **key** — ключ доступа к сервису (обязательный).
- **lastName** — фамилия физического лица (обязательный).
- **firstName** — имя физического лица (обязательный).
- **patronymic** — отчество физического лица (необязательный).
- **dob** — дата рождения в формате YYYY-MM-DD или DD.MM.YYYY (необязательный).
- **regionID** — код региона для поиска (необязательный, по умолчанию - все регионы).
- **page** — номер страницы результатов (необязательный, по умолчанию 1).

**Пример запроса:**

```
https://service.api-assist.com/parser/fssp_alim_api/?lastName=Петров&firstName=Иван&patronymic=Сергеевич&dob=1985-03-15&key=ВАШ_КЛЮЧ_ДОСТУПА
```

**Пример ответа на запрос:**

Ответ на запрос возвращается в формате JSON. Пример ответа:

```json
{
  "success": 1, // флаг успешности выполнения запроса (1 — успешно, 0 — ошибка)
  "total_rows_count": 2, // общее количество найденных записей
  "total_pages_count": 1, // общее количество страниц с результатами
  "result": [ // массив с результатами поиска, содержащий:
    {
      "debtor_name": "ПЕТРОВ ИВАН СЕРГЕЕВИЧ", // ФИО должника
      "debtor_dob": "1985-03-15", // дата рождения должника
      "debtor_address": "г. Москва, ул. Ленина, д. 10, кв. 5", // адрес должника
      "process_title": "12345/24/77001-ИП", // номер исполнительного производства
      "process_date": "2024-02-20", // дата исполнительного производства
      "document_title": "Судебный приказ от 15.01.2024 № 2-123/2024", // реквизиты исполнительного документа
      "document_type": "Судебный приказ", // тип исполнительного документа
      "document_date": "2024-01-15", // дата исполнительного документа
      "document_num": "2-123/2024", // номер исполнительного документа
      "document_organization": "Мировой судья судебного участка № 123 г. Москвы", // орган, выдавший документ
      "registry_date": "2024-03-01", // дата включения в реестр
      "payment_available": 1, // доступность оплаты (1 — доступна, 0 — недоступна)
      "subjects": [ // предметы исполнения с суммами
        {
          "title": "Задолженность по алиментам", // наименование задолженности
          "sum": "150000.00" // сумма в рублях
        },
        {
          "title": "Расходы по совершению исполнительных действий",
          "sum": "7000.00"
        }
      ],
      "department_title": "ОСП по Центральному району г. Москвы", // наименование отдела судебных приставов
      "department_address": "123456, г. Москва, ул. Тверская, д. 15", // адрес отдела
      "officer_name": "Иванова М.А.", // ФИО судебного пристава
      "officer_phones": [ // телефоны судебного пристава
        "+7 (495) 123-45-67",
        "+7 (495) 123-45-68"
      ]
    }
  ]
}
```
---

### Интерпретация ответа и обработка ошибок

**Общие рекомендации:**
- Если поле `success` заполнено и `success = 1` — перед вами успешный ответ, с которым можно работать. Только такие запросы учитываются в статистике и расходуют оплаченный лимит.
- Иначе, если поле `error` заполнено — запрос требует вашего внимания. Текст ошибки рекомендуется сохранить или отправить для дальнейшего анализа.
- Иначе, если поле `error` не заполнено — это ошибка, связанная со стабильностью источника. В таком случае мы рекомендуем игнорировать ответ и повторить запрос.

В данном разделе описаны возможные коды ответов сервиса и их значения. Каждый код ответа сопровождается пояснением и примером JSON-ответа.

#### 1. Код ответа - 200

- Поле `success = 1` - удалось получить информацию от источника. Такие и только такие запросы можно запускать в дальнейшую обработку.
- Поле `success = 0` - не удалось получить информацию от источника. Запрос не будет учтен в статистике. Необходимо повторить запрос.

**Пример успешного ответа без результатов:**
```json
{
  "success": 1,
  "total_rows_count": 0,
  "total_pages_count": 0,
  "result": []
}
```

#### 2. Код ответа - 403

Выдается сервисом в случае невозможности обработки запроса из-за ограничения доступа: закончилась подписка, превышен лимит и так далее. Причины ошибок отражены в поле `error` ответа. Ниже приведен список возможных ошибок с их описанием и кодами:

- **Invalid access key**  
  `error_code = 40301`  
  Указанный ключ доступа недействителен или отсутствует.

- **The subscription period has expired**  
  `error_code = 40302`  
  Доступ к сервису истек, требуется продление.

- **Invalid IP**  
  `error_code = 40303`  
  Запрос выполнен с IP-адреса, который не разрешён для доступа.

- **Day limit of requests exceeded**  
  `error_code = 40304`  
  Достигнут оплаченный лимит запросов на день.

- **Month limit of requests exceeded**  
  `error_code = 40305`  
  Достигнут оплаченный лимит запросов на месяц.

**Пример ответа:**
```json
{
  "error": "Invalid access key",
  "error_code": 40301
}
```

#### 3. Код ответа - 400

Выдается сервисом в случае невозможности обработки запроса из-за ошибки валидации запроса, неверного или отсутствующего значения обязательного поля. Поле `error_code` всегда равно `40001`, подробности доступны в поле `error`.

**Возможные ошибки валидации:**

- **lastName is required** — не указана фамилия должника.
- **firstName is required** — не указано имя должника.
- **dob is invalid** — неверная дата рождения.

**Пример ответа:**
```json
{
  "error": "lastName is required",
  "error_code": 40001
}
```