Skip to content

Проверка по перечню террористов

checkTerrorist

Тип HTTP запроса: POST

URL вызова: https://api.id-x.org/idx/api2/checkTerrorist

Поддерживаются следующие форматы передачи параметров:

  • 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 – успешное завершение функции, отличное от 0 значение – ошибка выполнения)
resultMessage String Нет Сообщение об ошибке
operationToken String Нет Уникальный идентификатор операции
list Array Нет Массив данных о террористе, подробнее см. данные о террористе
found Boolean Нет True – человек найден в реестре террористов, False – не найден

Пример вызова:

POST /idx/api2/checkTerrorist
Host: api.id-x.org
Content-Type: application/json
Accept: application/json

{
    "accessKey": "выданный accessKey",
    "secretKey": "выданный secretKey",
    "lastName": "Иванов",
    "firstName": "Иван",
    "midName": "Иванович"
}

Пример успешного ответа:

{
    "resultCode": 0,
    "resultMessage": " ",
    "operationToken": "a09062d0a75847b39f427b335c84da9b",
    "list": [*Данные о террористе*]
    "found": true
}

Пример неуспешного ответа:

{
    "resultCode": 0,
    "resultMessage": " ",
    "operationToken": "f9fc7f5c1e0c4cb4bb9e13e57fc35ef2",
    "list": [],
    "found": false
}

Данные о террористе

Это объект, содержащий следующие атрибуты:

Атрибут Тип Описание
lastName String Фамилия террориста
firstName String Имя террориста
midName String Отчество террориста
information String Остальная информация о террористе

Пример объекта "Данные о террористе" в формате json:

{
    "lastName": "ИВАНОВ",
    "firstName": "ИВАН",
    "midName": “ИВАНОВИЧ”,
    "information": “27.10.1970, Г. НАЗРАНЬ ЧИАССР”
}