`POST /monitorings`

Метод позволяет создавать запрос на создание объекта мониторинга

Заголовки

Название	Описание
Content-Type	Тип контента: application/json
Authorization	Заголовок авторизации

Тело запроса

Название	Тип	Формат	Обязательность	Описание
externalId	string	`^\w{1,256}$`	`false`	Клиентский идентификатор. Заполняется клиентом. Система контролирует уникальность идентификатора. Необходим для дедубликации запросов. По нему можно искать запросы
correlationId	string	`^\w{1,256}$`	`false`	Идентификатор группы отправленных запросов. Заполняется клиентом. Используется для связи нескольких запросов. По нему можно искать запросы
params	object	`Params`	`true`	Параметры мониторинга

В одном запросе может содержаться только один объект недвижимости. Для группировки проверок используйте correlationId.

Пример

POST /realty/rosreestr/v2/monitorings
Authorization: ReestroAuth apiKey=1269f58a-3d40-42e1-91ad-a4251566419c&portal.orgid=1269f58a-3d40-42e1-91ad-a4251566419c
Content-Type: application/json

{
  "externalId": "test40",
 "correlationId": "test5555",
 "params": {
     "cadastralNumber": "53:23:8100500:1638",
     "startDate": “2021-09-26T12:34:10”,
     "endDate": “2022-10-24T19:35:30”
     "properties": ["Owner", "Area"],
     "orderObjectExtract": true
 }
}

Ответы

200

Тело ответа

Объект мониторинга успешно создан. Тело ответа будет содержать описание созданного объекта EstateObject.

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

Название	Описание
Content-Type	Тип контента: `application/json`

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

  HTTP 200
  Content-Type: Application/json

{
  "monitoringId": "c2d4b8e0-200c-11ec-b16c-fba534fd64d6",
  "externalId": "test40",
  "correlationId": "test5555",
  "state": "Created",
  "createDate": "2021-09-28",
  "params": {
      "cadastralNumber": "53:23:8100500:1638",
      "startDate": "2021-09-26T12:34:10",
      "endDate": "2022-10-24T19:35:30",
      "properties": [
          "Owner",
          "Area"
      ],
      "orderObjectExtract": true
  },
  "changes": [],
  "extracts": []
}

400

Ошибки валидации запроса. В теле ответа содержится описание ошибки Error. Для данного метода возможны следующие ошибки:

Код ошибки	Описание
AbsenceOfRequiredField	Не указано одно из обязательных полей
`WRONG_FIELD_VALUE`	Значение поля не соответствует требуемому формату. Поле, формат которого не соответствует, указано в описании ошибки в message
`DUPLICATE_EXTERNAL_ID`	Указанный в запросе внешний идентификатор уже был использован ранее

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

  HTTP 400
  Content-Type Application/json

  {
      "code": "VALIDATION",
      "message": "Failed to validate input request",
      "target": "MONITORING_API",
      "errors":
      [
        {
          "code": "WRONG_FIELD_VALUE",
          "message": "Field params is invalid",
          "target": "MonitoringApi"
        }
      ]
  }

401

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

403

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

415

В заголовке Content-Type указан тип контента, который не поддерживается для данного метода