ForwardDocument

Метод ForwardDocument пересылает документ в указанный ящик.

POST /V2/ForwardDocument

Query Parameters:

• boxId – идентификатор ящика организации.

Request Headers:

• Authorization – данные, необходимые для авторизации.

Request Body:

Тело запроса должно содержать данные для пересылки документа, представленные структурой ForwardDocumentRequest:

message ForwardDocumentRequest
{
    required string ToBoxId = 1;
    required DocumentId DocumentId = 2;
}

• ToBoxId — идентификатор ящика организации, в который нужно переслать документ.

• DocumentId — идентификатор документа, который нужно переслать, представленный структурой DocumentId.

Status Codes:

• 200 OK – операция успешно завершена.

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

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

• 402 Payment Required – у организации с указанным идентификатором boxId закончилась подписка на API.

• 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен.

• 404 Not Found – не найдено сообщение или документ с указанными идентификаторами.

• 405 Method Not Allowed – используется неподходящий HTTP-метод.

• 409 Conflict – текущее состояние системы не позволяет корректно обработать запрос или запрещен прием документов от контрагентов согласно свойству Sociability из Organization.

• 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит информацию о пересылке документа, представленную структурой ForwardDocumentResponse:

message ForwardDocumentResponse
{
    optional Timestamp ForwardTimestamp = 1;
    optional ForwardedDocumentId ForwardedDocumentId = 2;
}

• ForwardTimestamp — метка времени пересылки документа, представленная структурой Timestamp.

• ForwardedDocumentId — идентификатор пересланного документа, представленный структурой ForwardedDocumentId.

Метод пересылает документ ForwardDocumentRequest.DocumentId из ящика boxId третьей стороне в ящик ForwardDocumentRequest.ToBoxId. Адресат пересылки получает снапшот состояния документа на момент времени пересылки.

Допускается пересылка одного документа нескольким получателям и пересылка одного документа несколько раз одному получателю.