Проверка нахождения в розыске ФССП¶
checkFsspWanted¶
Тип HTTP запроса: POST
URL вызова: https://api.id-x.org/idx/api2/checkFsspWanted
Поддерживаются следующие форматы передачи параметров:
-
JSON, Content-Type: application/json
-
Form submit, Content-Type: application/x-www-form-urlencoded
Параметры:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| accessKey | String | Да | Ключ доступа, выданный при регистрации в Системе IDX |
| secretKey | String | Да | Секретный ключ, выданный при регистрации в Системе IDX |
| lastName | String | Да | Фамилия |
| firstName | String | Да | Имя |
| midName | String | Нет | Отчество |
| birthDate | String | Да | Дата рождения в формате ДД.ММ.ГГГГ |
Функция возвращает:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| resultCode | Int | Да | Результат выполнения функции (0 – успешное завершение функции, -100 – данные не найдены, иные значения – ошибка выполнения) |
| resultMessage | String | Нет | Сообщение об ошибке |
| operationToken | String | Нет | Уникальный идентификатор операции |
| data | Массив объектов | Нет | Массив объектов с данными о разыскиваемых персонах, подробнее см. разыскиваемое лицо |
Пример вызова:
POST /idx/api2/checkFsspWanted
Host: api.id-x.org
Content-Type: application/json
Accept: application/json
{
"accessKey": "выданный accessKey",
"secretKey": "выданный secretKey",
"lastName": "ИВАНОВ",
"firstName": "ПЕТР",
"midName": "МИХАЙЛОВИЧ",
"birthDate": "10.01.1980"
}
Пример успешного ответа:
{
"resultCode": 0,
"resultMessage": "",
"operationToken": "82e9d47328947457353543565349",
"data": [
{
"lastName": "Иванов",
"firstName": "Петр",
"midName": "Михайлович",
"birthDate": "10.01.1980",
"region": "Москва",
"createdAt": "29.01.2025"
}
]
}
Пример успешного ответа, если данные не найдены:
{
"resultCode": -100,
"resultMessage": "Информация не найдена",
"operationToken": "82e9d47328947457353543565349",
"found": false,
"data": []
}
Разыскиваемое лицо¶
Это объект, содержащий следующие атрибуты:
| Атрибут | Тип | Описание |
|---|---|---|
| lastName | String | Фамилия разыскиваемого лица |
| firstName | String | Имя |
| midName | String | Отчество |
| birthDate | String | Дата рождения |
| region | String | Регион розыска |
| createdAt | String | Дата постановки в розыск |