API ФИАС 1.0

Методы API

getRegions

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

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

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

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

Тип данных Параметр Описание
String apiKey Персональный ключ для работы с API.
String query Фильтр по первым буквам наименования региона

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

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

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

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

   {
    "code": 1,
    "message": "Success!",
    "addressItems": [
        {
            "value": "Москва г",
            "fullValue": "Москва г",
            "postIndex": "",
            "regionCode": "77",
            "addressParts": [
                {
                    "level": "1",
                    "name": "Москва",
                    "type": "Город",
                    "shortType": "г",
                    "kladrCode": "7700000000000",
                    "fiasGuid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
                    "parentFiasGuid": "",
                    "oktmo": "45000000",
                    "centerStatus": 0
                }
            ]
        }
    ]
}

Тестирование API-метода

/api/getRegions