Перейти к основному содержимому

ParseGarAddress

Возвращает адрес объекта в государственном адресном реестре (ГАР).

GET /V1/ParseGarAddress

Параметры запроса

  • address — российский адрес в виде строки. Рекомендуем описывать в формате: <Регион>, <Муниципальный район>/<Городское поселение>, <Район>, <Город>, <Посёлок>, <Улица>, <Номер дома>/<Земельный участок>, <Номер квартиры>, <Номер комнаты>. Элементы адреса можно пропускать.
  • isAdministrativeDivision — муниципальное деление. Укажите значение false для административно-территориального деления. По умолчанию имеет значение true. Необязательный параметр.

Заголовки запроса

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 403 — запрос сделан от заблокированного клиента API.
  • 405 — используется неподходящий HTTP-метод.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

Тело ответа содержит адрес объекта в ГАР, представленный структурой GarAddress.

Если адрес из запроса не будет найден, метод вернет код 200 (OK) и пустой ответ.

Примеры использования

Пример HTTP-запроса:

GET /V1/ParseGarAddress?address=Свердловская обл, г.о. город Екатеринбург, г Екатеринбург, ул Викулова, д 63 к 1, кв 78&isAdministrativeDivision=false HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json

Пример тела ответа:

{
"FiasId": "e9824568-92cd-4276-a1ac-82fad56098cc",
"ZipCode": "620043",
"RegionCode": "66",
"MunicipalDistrict": {
"Abbreviation": "г.о.",
"Name": "город Екатеринбург"
},
"UrbanSettlement": {},
"City": {
"Abbreviation": "г",
"Name": "Екатеринбург"
},
"PlanningStructure": {},
"Street": {
"Abbreviation": "ул",
"Name": "Викулова"
},
"Garhouse": {
"Abbreviation": "д",
"Number": "63",
"AddNumber1": "1",
"AddAbbreviation1": "к"
},
"RoomWithinBuilding": {
"Abbreviation": "кв",
"Number": "78"
},
"RoomWithinApartment": {}
}

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года