API ФИАС 1.0
Методы API
getHouses
Метод возвращает список домов или номеров домов, по заданному фильтру и принадлежности
Построение запроса
Протокол | Наименование / адрес метода |
---|---|
REST JSON | /api/getHouses |
REST XML | /api/getHouses?format=xml |
SOAP | HouseResult getHouses(String apiKey, String parent, Int full = 0, String query = ””) |
Входящие параметры
Тип данных | Параметр | Описание |
---|---|---|
String | apiKey | Персональный ключ для работы с API. |
String | parent | Уникальный идентификатор адресного объекта предка по ФИАС или код КЛАДР |
Int | full | 0 – Возвращать только номер дома 1 - Возвращать номер дома, корпуса и строения |
String | query | Фильтр по первым символам номера дома |
обязательный параметр
Исходящие данные
Возвращает объект класса HouseResult
Пример ответа JSON
{
"code": 1,
"message": "Success!",
"houseItems": [
{
"value": "3/13",
"postIndex": "101000",
"fiasGuid": null,
"buildCount": "0",
"structureCount": "5"
}
]
}