API ФИАС 1.0

Методы API

getAreas

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

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

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

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

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

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

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

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

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

   {
    "code": 1,
    "message": "Success!",
    "addressItems": [
        {
            "value": "Анадырский р-н",
            "fullValue": "Чукотский АО, Анадырский р-н",
            "postIndex": "",
            "regionCode": "87",
            "addressParts": [
                {
                    "level": "3",
                    "name": "Анадырский",
                    "type": "Район",
                    "shortType": "р-н",
                    "kladrCode": "8700900000000",
                    "fiasGuid": "4d254ba7-a45c-4101-b372-5f5605382272",
                    "parentFiasGuid": "f136159b-404a-4f1f-8d8d-d169e1374d5c",
                    "oktmo": "77603000",
                    "centerStatus": 0
                },
                {
                    "level": "1",
                    "name": "Чукотский",
                    "type": "Автономный округ",
                    "shortType": "АО",
                    "kladrCode": "8700000000000",
                    "fiasGuid": "f136159b-404a-4f1f-8d8d-d169e1374d5c",
                    "parentFiasGuid": "",
                    "oktmo": "",
                    "centerStatus": 0
                }
            ]
        }
    ]
}