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