GetMessage

GetMessage

Имя ресурса: /V3/GetMessage

HTTP метод: GET

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

• boxId: идентификатор ящика;

• messageId: идентификатор сообщения;

• entityId: идентификатор документа из сообщения (может отсутствовать, если указан, то возвращаются не все сущности, а только связанные с данным документом);

В запросе должен присутствовать HTTP-заголовок Authorization с необходимыми данными для авторизации. Для использования этого метода текущий пользователь должен иметь доступ ко всем документам сообщения, в противном случае возвращается код ошибки 403 (Forbidden). Если в запросе был указан параметр entityId, то требуется доступ только к заданному документу.

В теле ответа содержится сообщение (цепочка документооборота) с идентификатором messageId из ящика boxId, сериализованное в протобуфер Message. Выдаваемая структура Message включает в себя сущности из всех дополнений, составляющих цепочку документооборота mesasgeId. Вся информация, относящаяся к данной цепочке (в частности, документы и подписи), по возможности помещается в протобуфер (информацию о том, в каких случаях возвращаемая цепочка может не содержать бинарного представления документов см. в описании структуры Content). В тех ситуациях, когда для каких-то документов цепочки документооборота бинарное представление не было выдано (по причине большого размера), его всегда можно получить при помощи метода GetEntityContent.

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

• 200 (OK) - операция успешно завершена;

• 400 (Bad Request) - данные в запросе имеют неверный формат или отсутствуют обязательные параметры;

• 401 (Unauthorized) - в запросе отсутствует HTTP-заголовок Authorization, или в этом заголовке содержатся некорректные авторизационные данные;

• 403 (Forbidden) - доступ к ящику с предоставленным авторизационным токеном запрещен;

• 404 (Not Found) - в указанном ящике нет сообщений с данным идентификатором;

• 405 (Method not allowed) - используется неподходящий HTTP-метод;

• 500 (Internal server error) - при обработке запроса возникла непредвиденная ошибка.