Page tree
Skip to end of metadata
Go to start of metadata

Запрос

Для пользователей подсказок DaData.ru:

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Token ${API_KEY}" \
  -d '{ "query": "Виктор Иван" }' \
  https://suggestions.dadata.ru/suggestions/api/4_1/rs/suggest/fio

Для пользователей standalone-подсказок:

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{ "query": "Виктор Иван" }' \
  http://ВАШ_СЕРВЕР:ПОРТ/suggestions/api/4_1/rs/suggest/fio

Заголовки

ЗаголовокОписание
Content-Type

Тип данных в запросе: application/json или application/xml

Accept
Тип данных в ответе: application/json или application/xml
Authorization

API-ключ в формате: Token ВАШ_КЛЮЧ

Только для пользователей подсказок DaData.ru

Параметры

ПараметрОбязательный?Описание
queryдаЗапрос, для которого нужно получить подсказки
count
нет
Количество возвращаемых подсказок (по умолчанию — 10, максимум — 20).
partsнетПодсказки по части ФИО
genderнетПол (UNKNOWN / MALE / FEMALE)

Ответ

Возвращается список объектов ФИО:

Поле

Описание

valueФИО одной строкой (как показывается в списке подсказок)
unrestricted_valueФИО одной строкой (полное)
data.surnameФамилия
data.nameИмя

data.patronymic

Отчество
data.gender

Пол

  • FEMALE;
  • MALE;
  • UNKNOWN  — не удалось однозначно определить.
data.qcКод качества
  • 0 - если все части ФИО найдены в справочниках.
  • 1 - если в ФИО есть часть не из справочника
Не используются
data.source

Примеры

Запрос:

{
  "query": "Виктор Иван",
  "count": 7
} 

Ответ:

{
    "suggestions": [
        {
            "value": "Иванов Виктор",
            "unrestricted_value": "Иванов Виктор",
            "data": {
                "surname": "Иванов",
                "name": "Виктор",
                "patronymic": null,
                "gender": "MALE"
            }
        },
        {
            "value": "Иванченко Виктор",
            "unrestricted_value": "Иванченко Виктор",
            "data": {
                "surname": "Иванченко",
                "name": "Виктор",
                "patronymic": null,
                "gender": "MALE"
            }
        },
        {
            "value": "Виктор Иванович",
            "unrestricted_value": "Виктор Иванович",
            "data": {
                "surname": null,
                "name": "Виктор",
                "patronymic": "Иванович",
                "gender": "MALE"
            }
        }
    ]
}

Запрос:

<req>
    <query>Виктор Иван</query>
    <count>7</count>
</req>

Ответ:

<SuggestResponse>
    <suggestions>
        <value>Иванов Виктор</value>
        <unrestricted_value>Иванов Виктор</unrestricted_value>
        <data>
            <surname>Иванов</surname>
            <name>Виктор</name>
            <patronymic/>
            <gender>MALE</gender>
        </data>
    </suggestions>
    <suggestions>
        <value>Иванченко Виктор</value>
        <unrestricted_value>Иванченко Виктор</unrestricted_value>
        <data>
            <surname>Иванченко</surname>
            <name>Виктор</name>
            <patronymic/>
            <gender>MALE</gender>
        </data>
    </suggestions>
    <suggestions>
        <value>Виктор Иванович</value>
        <unrestricted_value>Виктор Иванович</unrestricted_value>
        <data>
            <surname/>
            <name>Виктор</name>
            <patronymic>Иванович</patronymic>
            <gender>MALE</gender>
        </data>
    </suggestions>
</SuggestResponse>
  • No labels