API ФИАС 1.0

Методы API

getRooms

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

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

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

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

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

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

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

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

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

   {
    "code": 1,
    "message": "Success!",
    "roomItems": [
        {
            "value": "7",
            "postIndex": "142406",
            "fiasGuid": "ca9a2152-8a5e-46a3-84e9-3abde6b3c42e"
        }
    ]
}