GET /objects

Метод позволяет получить список объектов, которые соответствуют указанному в запросе адресу.

Заголовки

Название Описание
Authorization Заголовок авторизации

Параметры

Название Тип Описание
address string Адрес в виде строки

Правила заполнения адреса в виде строки address

Чтобы система правильно распознала адрес, необходимо следовать следующим правилам при его заполнении:

  1. Уровни адреса в строке должны быть разделены запятой.

Важно обратить внимание на разделение адресных уровней дома, корпуса и строения. Например: если дом и корпус будут записаны как : д. 14/2 - то данное значение будет определено системой как номер дома. Для определения корпуса как адресного уровня необходимо отделить его от дома запятой: д. 14, к. 2

  1. Аббревиатура адресного уровня не должна дублироваться.

Пример дублирования: д. д. 27

  1. Аббревиатура адресного уровня должна содержаться в списке поддерживаемых аббревиатур.

Список аббревиатур, которые поддерживает система, можно посмотреть здесь

Пример

  GET /realty/address/v1/objects?address=г. Новосибирск, ул. Романтиков, д. 3, кв. 116
  Authorization: ReestroAuth auth.sid=717726209B543848879C33F2BDDAB9F8561EFAC465A5DC439193062C700FAFDA&portal.orgid=1269f58a-3d40-42e1-91ad-a4251566419c

Ответы

200

Ответ содержит список найденных объектов. В описании каждого найденного объекта указываются:

Название Тип Описание
cadastralNumber string ^\d{2}:\d{2}:\d{6,7}:\d+$ Кадастровый номер объекта
address Address Адрес объекта недвижимости

Заголовки ответа

Название Описание
Content-Type Тип содержимого

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

  HTTP 200
  Content-Type: Application/json
  [
  {
    "cadastralNumber": "54:35:061735:1199",
    "address" :
    {
      "structuralAddress":
      {
        "region": "54",
        "city": {
          "name": "Новосибирск",
          "abbreviation": "г"
        },
        "urbanDistrict":
        {
          "name": "Ленинский",
          "abbreviation": "р-н"
        },
        "street":
        {
          "name": "Романтиков",
          "abbreviation": "ул"
        },
        "house":
        {
          "name": "3",
          "abbreviation": "д"
        },
        "apartment":
        {
          "name": "116",
          "abbreviation": "кв"
        }
      },
      "note": "Новосибирская область, город Новосибирск, Ленинский район, улица Романтиков, дом 3, квартира 116"
    }
  }
  ]

400

Ошибки валидации запроса. В теле ответа содержится описание ошибки Error.

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

  HTTP 400
  Content-Type Application/json
  {
    "code": "validation",
    "message": "Failed to validate input request",
    "target": "api"
  }

401

Ошибка авторизации: пользователь не авторизован

403

Ошибка аутентификации: пользователь не имеет доступа к ресурсам организации, которая указана в заголовке авторизации

404

Объекты, удовлетворяющие параметрам запроса, не найдены.