Санкции
Атрибут | Значение |
---|---|
Название | info-radar-salary-data |
Тип | Адаптер для получения санкций лица |
Наименование | Санкции |
Версия | Реализовано 21.07.2025 |
Сервис для получения санкций лица.
Общая информация
Цель документации — обеспечить полное понимание и возможность эффективного использования сервиса как для конечных пользователей, так и для разработчиков.
Сервис является частью платформы Агредатор. Перед изучением данной документации ознакомьтесь со следующими обязательными документами по интеграции с платформой:
Параметр | Название | Тип | Обязательное | Пример |
---|---|---|---|---|
service | Имя сервиса (всегда info-radar-sanctions ) |
string | + | info-radar-sanctions |
type | Тип запроса | string (enum) | + | list |
data | Данные запроса | object | + | см. ниже |
Типы запросов type
type | Значение |
---|---|
list | Получение информации о санкциях лица |
Структура data
Параметр | Название | Тип | Обязательное | Пример |
---|---|---|---|---|
TargetName | Имя лица, попавшего под санкции | string | + | Иванов Иван Иванович |
TargetBirthDate | Дата рождения лица, попавшего под санкции | string($date-time) | + | 2003-03-20 |
Структура элементов data
TargetName
описание: Имя лица, попавшего под санкции.
Тип данных: string
Обязательное: +
Пример: Иванов Иван Иванович
TargetBirthDate
описание: Дата рождения лица, попавшего под санкции. В формате (YYYY-MM-DD)
Тип данных: string($date-time)
Обязательное: +
Пример: 2003-03-20
Параметры ответа
Параметр | Название | Обязательное | Тип | Пример |
---|---|---|---|---|
success | Статус запроса | + | string | true |
result | Хеш с результатом | - | object | См. ниже |
exception | Ошибка | - | string | Что-то пошло не так |
Параметры result
Поле | Назначение | Тип | Обязательное | Пример |
---|---|---|---|---|
Items | Массив найденных лиц попавших под санкции | array[object] | + | Items |
Элемент массива
Items
Поле | Назначение | Тип | Пример |
---|---|---|---|
TargetName | Имя цели / лица | string | "Иванов Иван Иванович" |
TargetBirthDate | Дата рождения цели | string (date) | "2003-03-20T00:00:00" |
Name | Название перечня | string | "Перечень террористов и экстремистов (Действующие)" |
ImposedBy | Страна или орган, наложивший включение | string | "Россия" |
InclusionDate | Дата включения в перечень | string / null | null |
Пример json запроса
{
"service": "info-radar-sanctions",
"type": "list",
"data": {
"TargetName": "Иванов Иван Иванович",
"TargetBirthDate": "2003-03-20"
}
}
Примеры json ответов
{
"success": true,
"result": {
"Items": [
{
"TargetName": "ИВАНОВ ИВАН ИВАНОВИЧ",
"TargetBirthDate": "2003-03-20T00:00:00",
"Name": "Перечень террористов и экстремистов (Действующие)",
"ImposedBy": "Россия",
"InclusionDate": null
}
]
}
}
Пример ошибки:
{
"success": false,
"exception": "Что-то пошло не так"
}