API ФИАС 1.0
Методы API
getMunSettlements
Метод возвращает список городских и сельских поселений, по заданному фильтру и принадлежности
Построение запроса
| Протокол | Наименование / адрес метода |
|---|---|
| REST JSON | /api/getMunSettlements |
| REST XML | /api/getMunSettlements?format=xml |
| SOAP | AddressResult getMunSettlements (String apiKey, String parent, Int cities = 0, String query = ””) |
Входящие параметры
| Тип данных | Параметр | Описание |
|---|---|---|
| String | apiKey | Персональный ключ для работы с API. |
| String | parent | Уникальный идентификатор адресного объекта предка по ФИАС или код КЛАДР |
| Int | cities | Включать в список внутренние города (для Москвы и Санкт-Петербурга) 0 – не включать (по умолчанию) 1 – включать |
| String | query | Фильтр по первым буквам наименования муниципального района или городского округа |
обязательный параметр
Исходящие данные
Возвращает объект класса AddressObject
Пример ответа JSON
{}