GET /objects
Метод позволяет получить список объектов, которые соответствуют указанному в запросе адресу.
Заголовки
| Название | Описание |
|---|---|
| Authorization | Заголовок авторизации |
Параметры
| Название | Тип | Формат | Обязательность | Описание |
|---|---|---|---|---|
| address | string | true |
Адрес в виде строки | |
| filter | boolean | false |
Фильтр результата поиска. Возможные значения: true;false |
Правила заполнения адреса в виде строки address
Чтобы система правильно распознала адрес, необходимо следовать следующим правилам при его заполнении:
- Уровни адреса в строке должны быть разделены запятой.
Важно обратить внимание на разделение адресных уровней дома, корпуса и строения. Например: если дом и корпус будут записаны как :
д. 14/2- то данное значение будет определено системой как номер дома. Для определения корпуса как адресного уровня необходимо отделить его от дома запятой:д. 14, к. 2
- Аббревиатура адресного уровня не должна дублироваться.
Пример дублирования:
д. д. 27
- Аббревиатура адресного уровня должна содержаться в списке поддерживаемых аббревиатур.
Список аббревиатур, которые поддерживает система, можно посмотреть здесь
Правила заполнения фильтра результата поиска:
- если в filter передается значение true, то будут возвращятся только полностью совпадающие результаты;
- если передается значение false, то будут выводятся все наёденные результаты, отсортированные по наибольшему совпадению
Пример
GET /realty/address/v1/objects?address=г. Новосибирск, ул. Романтиков, д. 3, кв. 116
Authorization: ReestroAuth apiKey=235dc85c-f7f9-4dc0-8bbf-dad9e0185afd&portal.orgid=1748b89b-7d34-4d47-b479-b06b40ab1a30
Ответы
Тело ответа
Ответ содержит список найденных объектов. В описании каждого найденного объекта указываются:
| Название | Тип | Формат | Обязательность | Описание |
|---|---|---|---|---|
| cadastralNumber | string | ^\d{2}:\d{2}:\d{6,7}:\d+$ |
true | Кадастровый номер объекта |
| address | object | Address | true | Адрес объекта недвижимости |
| matchResult | string | MatchResult | false | результат сравнения адреса с введённым пользователем |
Заголовки ответа
| Название | Описание |
|---|---|
| Content-Type | Тип содержимого |
Пример ответа
HTTP 200
Content-Type: Application/json
[
{
"cadastralNumber": "54:35:061735:1199",
"address" :
{
"structuralAddress":
{
"region": "54",
"city": {
"name": "Новосибирск",
"abbreviation": "г"
},
"urbanDistrict":
{
"name": "Ленинский",
"abbreviation": "р-н"
},
"street":
{
"name": "Романтиков",
"abbreviation": "ул"
},
"house":
{
"name": "3",
"abbreviation": "д"
},
"apartment":
{
"name": "116",
"abbreviation": "кв"
}
},
"note": "Новосибирская область, город Новосибирск, Ленинский район, улица Романтиков, дом 3, квартира 116"
}
}
]
Ошибки валидации запроса. В теле ответа содержится описание ошибки Error.
Пример ответа
HTTP 400
Content-Type Application/json
{
"code": "validation",
"message": "Failed to validate input request",
"target": "api"
}
Ошибка авторизации: пользователь не авторизован
Ошибка аутентификации: пользователь не имеет доступа к ресурсам организации, которая указана в заголовке авторизации
Объекты, удовлетворяющие параметрам запроса, не найдены.