Запрос
Для пользователей подсказок 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 | нет | Количество возвращаемых подсказок (по умолчанию — 5, максимум — 20). |
parts | нет | Подсказки по части ФИО |
gender | нет | Пол (UNKNOWN / MALE / FEMALE) |
Ответ
Возвращается список объектов ФИО:
Поле | Тип данных | Описание |
---|---|---|
value | string(1000) | ФИО одной строкой |
unrestricted_value | string(1000) | = value |
data.surname | string(100) | Фамилия |
data.name | string(100) | Имя |
data.patronymic | string(100) | Отчество |
data.gender | string(10) | Пол
|
data.qc | string(10) | Код качества
|
data.source | Не заполняется |
Примеры
Запрос:
{ "query": "Виктор Иван", "count": 7 }
Ответ:
{ "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": "Виктор Иванович" } ] }
Запрос:
<req> <query>Виктор Иван</query> <count>7</count> </req>
Ответ:
<SuggestFioResponse> <suggestions> <data> <surname>Иванов</surname> <name>Виктор</name> <patronymic/> <gender>MALE</gender> </data> <value>Виктор Иванов</value> </suggestions> <suggestions> <data> <surname>Иванченко</surname> <name>Виктор</name> <patronymic/> <gender>MALE</gender> </data> <value>Виктор Иванченко</value> </suggestions> <suggestions> <data> <surname/> <name>Виктор</name> <patronymic>Иванович</patronymic> <gender>MALE</gender> </data> <value>Виктор Иванович</value> </suggestions> </SuggestFioResponse>
Обзор
Инструменты контента