API ФИАС 1.0

Методы API

getStructures

Метод возвращает список корпусов, по заданному фильтру и принадлежности

Построение запроса

Протокол Наименование / адрес метода
REST JSON /api/getStructures
REST XML /api/getStructures?format=xml
SOAP HouseResult  getStructures (String apiKey, String parent, String house, String build, String query = ””)

Входящие параметры

Тип данных Параметр Описание
String apiKey Персональный ключ для работы с API.
String parent Уникальный идентификатор адресного объекта предка по ФИАС или код КЛАДР
String house Номер дома запрашиваемого строения
String build Номер корпуса запрашиваемого строения
String query Фильтр по первым символам строения

  обязательный параметр

Исходящие данные

Возвращает объект класса HouseResult

Пример ответа JSON

   {
    "code": 1,
    "message": "Success!",
    "houseItems": [
        {
            "value": "1",
            "postIndex": "101000",
            "fiasGuid": "d94f5f41-7c1b-4c30-91c6-07ee6630e7e1",
            "buildCount": "0",
            "structureCount": "2"
        },
        {
            "value": "3",
            "postIndex": "101000",
            "fiasGuid": "d41f65d0-4819-46ce-8e5b-b6f266d5c815",
            "buildCount": "0",
            "structureCount": "2"
        }
    ]
}