GET /events

Метод позволяет получить список событий, произошедших с документооборотами. Событие возникает, когда для документооборота:

Событие Описание объекта события Статус, в котором приходит событие
выставлены требования оплаты сервиса PaymentService WaitingServicePayment
назначены государственные пошлины, которые необходимо оплатить GovFee AwaitingGovFeePayment
сгенерированы заявления для подписания SignStatements WaitingSignStatements
приходит ответ от Росреестра RosreestrResponse Processed, Suspend, Rejected, TimeOut
определена ошибка обработки Error ValidationError

Событие в новостной ленте можно увидеть в течении 3-х месяцев с момента его возникновения

Параметры

Название Тип Формат Обязательность Описание
afterEventId string Guid false Временная метка, после которой необходимо получить события. Если параметр указан, то в ответе будут располагаться события, которые были созданы позднее указанной метки
count string false Количество событий в ответе. Максимальное количество событий 100. По умолчанию - 30

Заголовки

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

Пример

  GET /realty/rosreestr/v2/events?afterEventId=f7a0fcd6-60ed-4e02-b6a6-d6de8a2458c6
  Authorization:ReestroAuth apiKey=235dc85c-f7f9-4dc0-8bbf-dad9e0185afd&portal.orgid=1748b89b-7d34-4d47-b479-b06b40ab1a30

Ответы

200

События получены. В теле ответа содержится список событий

Тело ответа

Название Тип Формат Обязательность Описание
lastEventId string Guid true Метка после которой можно продолжать вычитывание
events array DocflowEvent true Список событий, которые произошли с документооборотами

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

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

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

  HTTP 200
  Content-Type: Application/json
  {
    "lastEventId": "5a8c791a-6404-4cda-b3f8-f5ec45cd685b",
    "events":
    [
      {
        "eventId": "5a8c791a-6404-4cda-b3f8-f5ec45cd685b",
        "eventDate": "2011-01-01T15:03:01.012345Z",
        "docflowId": "1f3ba8ad-b868-46f2-9088-56aa2753bc88",
        "externalId": "3b09f62d-d151-4a8f-9970-441cc0574fcf"
        "docflowState": "WaitingServicePayment",
        "docflowType": "ObjectExtract",
        "requirement":
        {
          "service": "Extract",
          "message": "Недостаточно средств для заказа выписки"
        }
      }
    ]
  }

400

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

Код ошибки Описание
WrongFieldValue Значение поля не соответствует требуемому формату. Поле, формат которого не соответствует, указано в описании ошибки в message

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

  HTTP 400
  Content-Type Application/json
  {
    "code": "validation",
    "message": "Failed to validate input request",
    "target": "api",
    "errors":
    [
      {
        "code": "WrongFieldValue",
        "message": "afterEventId should be guid",
        "target": "EntityApi"
      }
    ]
  }

401

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

403

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