API ФИАС 1.0
Методы API
getBuilds
Метод возвращает список корпусов, по заданному фильтру и принадлежности
Построение запроса
Протокол | Наименование / адрес метода |
---|---|
REST JSON | /api/getBuilds |
REST XML | /api/getBuilds?format=xml |
SOAP | HouseResult getHouses(String apiKey, String parent, String house, String structure, String query = ””) |
Входящие параметры
Тип данных | Параметр | Описание |
---|---|---|
String | apiKey | Персональный ключ для работы с API. |
String | parent | Уникальный идентификатор адресного объекта предка по ФИАС или код КЛАДР |
String | house | Номер дома запрашиваемого корпуса |
String | structure | Номер строения запрашиваемого корпуса |
String | query | Фильтр по первым символам корпуса |
обязательный параметр
Исходящие данные
Возвращает объект класса HouseResult
Пример ответа JSON
{
"code": 1,
"message": "Success!",
"houseItems": [
{
"value": "7",
"postIndex": "115093",
"fiasGuid": "dde763cc-26ce-4853-bb1c-1a3e1b856899",
"buildCount": "2",
"structureCount": "2"
},
{
"value": "7А",
"postIndex": "115093",
"fiasGuid": "2e62108f-572d-418c-9269-a9d6f1e9d202",
"buildCount": "2",
"structureCount": "2"
}
]
}