API ФИАС 1.0

Методы API

getPlans

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

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

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

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

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

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

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

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

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

   {
    "code": 1,
    "message": "Success!",
    "addressItems": [
        {
            "value": "Мирный снт",
            "fullValue": "Московская обл, Мирный снт",
            "postIndex": "",
            "regionCode": "50",
            "addressParts": [
                {
                    "level": "65",
                    "name": "Мирный",
                    "type": "Садовое товарищество",
                    "shortType": "снт",
                    "kladrCode": "50000000000000200",
                    "fiasGuid": "50741288-79fe-4a1b-b4e5-b5559fbc452f",
                    "parentFiasGuid": "29251dcf-00a1-4e34-98d4-5c47484a36d4",
                    "oktmo": "46648458",
                    "centerStatus": 0
                },
                {
                    "level": "1",
                    "name": "Московская",
                    "type": "Область",
                    "shortType": "обл",
                    "kladrCode": "5000000000000",
                    "fiasGuid": "29251dcf-00a1-4e34-98d4-5c47484a36d4",
                    "parentFiasGuid": "",
                    "oktmo": "",
                    "centerStatus": 0
                }
            ]
        }
    ]
}