GetNewEvents¶
Предупреждение
Версия метода устарела. Для получения событий используйте метод GetNewEvents.
Имя ресурса: /V4/GetNewEvents
HTTP метод: GET
Параметры строки запроса:
boxId: идентификатор ящика организации.
afterEventId: идентификатор последнего полученного события (может отсутствовать);
В запросе должен присутствовать HTTP-заголовок Authorization
с необходимыми данными для авторизации.
Для использования этого метода текущий пользователь должен иметь доступ ко всем документам организации, в противном случае возвращается код ошибки 403 (Forbidden).
В теле ответа содержится список событий в ящике boxId, следующих за событием с идентификатором afterEventId в хронологическом порядке. При этом само событие с идентификатором afterEventId в этот список не включается. Список возвращается в виде сериализованной структуры данных BoxEventList.
Содержимое документов, ассоциированных с событиями из списка, в структуру данных не сохраняется, то есть возвращается только метаинформация об изменениях, в ящике. Такой подход гарантирует, что ответ на запрос имеет предсказуемый и небольшой размер.
Если список изменений содержит более 100 элементов, то в ответе возвращаются первые 100 событий, а поле BoxEventList.TotalCount содержит общее количество новых событий. Если параметр afterEventId отсутствует в запросе, то метод возвращает самые старые события из ящика boxId (начало истории изменений в ящике).
Предполагается, что интеграционное решение будет помнить идентификатор последнего прочитанного события (BoxEvent.EventId) для конкретного ящика. Соответственно, данный метод позволяет интеграционному решению узнать, какие изменения произошли в ящике с момента последнего подключения интеграционного решения к Диадоку.
Возможные HTTP-коды возврата:
200 (OK) - операция успешно завершена;
400 (Bad Request) - данные в запросе имеют неверный формат или отсутствуют обязательные параметры;
401 (Unauthorized) - в запросе отсутствует HTTP-заголовок
Authorization
, или в этом заголовке содержатся некорректные авторизационные данные;402 - у организации с указанным идентификатором
boxId
закончилась подписка на API.403 (Forbidden) - доступ к ящику с предоставленным авторизационным токеном запрещен;
405 (Method not allowed) - используется неподходящий HTTP-метод;
500 (Internal server error) - при обработке запроса возникла непредвиденная ошибка.