Сравнение версий

Старая версия 2

changes.mady.by.user Антон Жиянов

Сохранено

по сравнению с

Новая версия 3

changes.mady.by.user Антон Жиянов

Сохранено

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Подсказки возвращают список ФИО, подходящих под условия запроса.

Запрос

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

Без форматирования
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Token ${API_KEY}" \
  -d '{ "query": "Виктор Иван" }' \
  https://dadata.ru/api/v2

...

/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 ${API_KEY}

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

Параметры

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

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

Дополнительные возможности

...

ответа 

Ответ

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

Включить страницу
Объект ФИО
Объект ФИО

Примеры

JSON

Запрос:

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

...

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

...

Запрос:
 Блок  кода
languagehtml/xml
<req>
    <query>Виктор Иван</query>
    <count>7</count>
</req>
...