Вычитывание новостей

Имя ресурса: /news

HTTP метод: GET

Вычитывание новостей позволяет получить события по документооборотам. Осуществляется методом GET /news?after={after}

  • after: токен (lastToken) последнего обработанного события.

Если токен не указан, то вычитывание начинается с текущего момента времени.

Алгоритм вычитывания новостей:

  1. Отправляем запрос без параметра after. В ответе получаем идентификатор lastToken, с которого будем продолжать вычитывание.
  2. Регистрируем один или несколько ДО на отправку.
  3. Отправляем запрос, в котором параметр after принимает значение lastToken из предыдущего ответа (или идентификатор последней обработанной новости). Если появились новости с последнего запроса новостей, то ответ будет содержать описание новостей и новый идентификатор lastToken.
  4. Если при обработке новостей случилась ошибка на стороне клиента, то клиент должен запомнить token последнего обработанного события и передать его в параметр запроса after, чтобы продолжить обработку новостей.

Пример запроса

GET /realty/v1/news?after=3254tsadf5 HTTP/1.0
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

В ответ возвращается список новостей по документооборотом и токен для продолжения вычитывания. Новости содержат набор событий на изменение статуса документооборота. Событие на изменение статуса ДО может содержать одно из:

  • Result - результат запроса в Росреестр
  • Error - описание возникшей ошибки
  • Requirements - описание действий, которые нужно совершить для продолжения обработки запроса
Возможные HTTP-коды возврата:
  • 200 - успешная отправка
  • 401 - при запросе методов API в случае отсутствия заголовка Authorization или при некорректном значении последнего;
  • 403 - если для данного accountId доступ ограничен.