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