GenerateForwardedDocumentProtocol

Имя ресурса: /V2/GenerateForwardedDocumentProtocol

HTTP метод: GET

Параметры строки запроса:

  • boxId: идентификатор ящика;
  • fromBoxId: идентификатор ящика инициатора пересылки документа;
  • messageId: идентификатор сообщения;
  • documentId: идентификатор сущности документа;
  • forwardEventId: идентификатор события пересылки документа;

В запросе должен присутствовать HTTP-заголовок Authorization с необходимыми данными для авторизации.

Данный метод позволяет адресату пересылки документа третьей стороне выгрузить протокол, отражающий состояние данного документа на момент времени пересылки.

Он работает также как и метод GenerateDocumentProtocol, только идентификатор документа, для которого выгружается протокол, задается набором параметров fromBoxId, messageId, documentId, forwardEventId.

Возможные HTTP-коды возврата:

  • 200 (OK) - операция успешно завершена;
  • 400 (Bad Request) - данные в запросе имеют неверный формат или отсутствуют обязательные параметры;
  • 401 (Unauthorized) - в запросе отсутствует HTTP-заголовок Authorization, или в этом заголовке содержатся некорректные авторизационные данные;
  • 403 (Forbidden) - доступ к ящику с предоставленным авторизационным токеном запрещен;
  • 404 (Not Found) - не найдено сообщение/документ/сущность с заданным идентификатором;
  • 405 (Method not allowed) - используется неподходящий HTTP-метод;
  • 409 (Conflict) - формирование протокола передачи для данного документа невозможно.
  • 500 (Internal server error) - при обработке запроса возникла непредвиденная ошибка.