GetLastEvent¶
Метод GetLastEvent
возвращает последнее событие в ящике.
- GET /GetLastEvent¶
- Query Parameters:
boxId – идентификатор ящика организации.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Status Codes:
200 OK – операция успешно завершена.
204 No Content – в ящике нет событий.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorization
или в этом заголовке содержатся некорректные авторизационные данные.402 Payment Required – у организации с указанным идентификатором
boxId
отсутствует или закончилась подписка на API.403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.
405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Body:
Тело ответа содержит последнее событие в ящике, представленное структурой BoxEvent.
Лента событий формируется по подразделению организации, в котором состоит пользователь. Подразделение указано в поле UserDepartmentId
структуры OrganizationUserPermissions.
Важно
К подразделению организации привязываются все события, произошедшие с 15.03.2017. События, произошедшие до этой даты, может получить только пользователь, который имеет доступ ко всем документам организации.
Если у пользователя есть доступ ко всем документам организации, в ленту попадут события по всему ящику. Доступ пользователя указан в поле AllDocuments
структуры DocumentAccessLevel.
События по черновикам доступны пользователям, у которых есть доступ ко всем документам организации, так как черновики не имеют привязки к подразделению.
Метод возвращает только информацию об изменениях в ящике, содержимое документов в ответе не возвращается. Это гарантирует, что ответ на запрос будет иметь небольшой размер.
См. также
- Другие методы для работы с событиями:
GetEvent — возвращает информацию о конкретном событии
GetForwardedDocumentEvents — возвращает список событий пересылки документов в ящик
GetNewEvents — возвращает ленту событий в ящике