API ФИАС 1.0
Методы API
getSettlements
Метод возвращает список городов и/или населенных пунктов, по заданному фильтру и принадлежности
Построение запроса
Протокол | Наименование / адрес метода |
---|---|
REST JSON | /api/getSettlements |
REST XML | /api/getSettlements?format=xml |
SOAP | AddressResult getSettlements(String apiKey, String parent, Int level = 0, String query = ””) |
Входящие параметры
Тип данных | Параметр | Описание |
---|---|---|
String | apiKey | Персональный ключ для работы с API. |
String | parent | Уникальный идентификатор адресного объекта предка по ФИАС или код КЛАДР |
Int | level | Уровень части адреса по ФИАС 0 – возвращает все ( по умолчанию ) 4 – города 6 – населенные пункты |
String | query | Фильтр по первым буквам наименования города или населенного пункта |
обязательный параметр
Исходящие данные
Возвращает объект класса AddressObject
Пример ответа JSON
{
"code": 1,
"message": "Success!",
"addressItems": [
{
"value": "Починки с",
"fullValue": "Мордовия Респ, Большеберезниковский р-н, Починки с",
"postIndex": "431756",
"regionCode": "13",
"addressParts": [
{
"level": "6",
"name": "Починки",
"type": "Село",
"shortType": "с",
"kladrCode": "1300500002500",
"fiasGuid": "f3505787-231a-47c6-aa12-0ac45545918e",
"parentFiasGuid": "9bcd8d19-9dbf-43c7-b11e-772d3bd74ccf",
"oktmo": "89610450101",
"centerStatus": 0
},
{
"level": "3",
"name": "Большеберезниковский",
"type": "Район",
"shortType": "р-н",
"kladrCode": "1300500000000",
"fiasGuid": "9bcd8d19-9dbf-43c7-b11e-772d3bd74ccf",
"parentFiasGuid": "37a0c60a-9240-48b5-a87f-0d8c86cdb6e1",
"oktmo": "",
"centerStatus": 0
},
{
"level": "1",
"name": "Мордовия",
"type": "Республика",
"shortType": "Респ",
"kladrCode": "1300000000000",
"fiasGuid": "37a0c60a-9240-48b5-a87f-0d8c86cdb6e1",
"parentFiasGuid": "",
"oktmo": "",
"centerStatus": 0
}
]
}
]
}