ForwardDocument (V2)
Метод устарел и будет удален из API после 01 ноября 2025 года. Подробнее в истории изменений.
Пересылает документ в указанный ящик.
POST /V2/ForwardDocument
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Тело запроса
Тело запроса должно содержать данные для пересылки документа, представленные структурой ForwardDocumentRequest:
message ForwardDocumentRequest {
required string ToBoxId = 1;
required DocumentId DocumentId = 2;
}
ToBoxId— идентификатор ящика организации, в который нужно переслать документ.DocumentId— идентификатор документа, который нужно переслать, представленный структурой DocumentId.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен.404— не найдены документ или сообщение с указанным идентификатором.405— используется неподходящий HTTP-метод.409— текущее состояние системы не позволяет корректно обработать запрос или запрещен прием документов от контрагентов согласно свойствуSociabilityв структуре Organization.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит информацию о пересылке документа, представленную структурой ForwardDocumentResponse:
message ForwardDocumentResponse {
optional Timestamp ForwardTimestamp = 1;
optional ForwardedDocumentId ForwardedDocumentId = 2;
}
ForwardTimestamp— время пересылки документа, представленное структурой Timestamp.ForwardedDocumentId— идентификатор пересланного документа, представленный структурой ForwardedDocumentId.
Метод пересылает документ ForwardDocumentRequest.DocumentId из ящика boxId третьей стороне в ящик ForwardDocumentRequest.ToBoxId. При этом:
- Третья сторона получает снапшот состояния документа на момент времени пересылки, дальнейшие изменения документа в ящике третьей стороны не отображаются.
- Пересланные документы не отображаются в веб-интерфейсе в ящике третьей стороны.
- Статус документа при пересылке не изменяется, уведомлениями никому из участников не приходят.
Допускается пересылка одного документа нескольким получателям и пересылка одного и того же документа одному получателю несколько раз.
Примеры использования
Пример HTTP-запроса:
POST /V2/ForwardDocument?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/json
Пример тела запроса:
{
"ToBoxId": "{{boxId_third}}",
"DocumentId": {
"MessageId": "{{messageId}}",
"EntityId": "{{documentId}}"
}
}
Пример тела ответа:
{
"ForwardedDocumentId": {
"DocumentId": {
"EntityId": "da7cd73e-ff49-4a23-a018-42d27487e536",
"MessageId": "ba04162c-e26f-448f-a370-299b4f15b6d1"
},
"ForwardEventId": "631cf632-d217-4f7a-8d19-c46d4e054388",
"ForwardEventIdGuid": "631cf632-d217-4f7a-8d19-c46d4e054388",
"FromBoxId": "09ae254c5cd0408284de7ccb46d86f82@diadoc.ru"
},
"ForwardTimestamp": {
"Ticks": 638806440596039464
}
}
См. также
Инструкции:
Методы для работы с документами:
- Delete — отмечает указанный документ как удаленный
- GetContent — возвращает XSD-схему документа
- GetDocument (V3) — возвращает данные документа по указанному идентификатору
- GetDocumentActions — возвращает список действий, доступных текущему пользователю для указанного документа, шаблона или черновика
- GetDocumentHistory — возвращает историю событий по указанному документу, шаблону или черновику
- GetDocuments (V3) — возвращает список документов, соответствующих заданным параметрам
- GetDocuments (V4) — возвращает список документов, соответствующих заданным параметрам
- GetDocumentsByMessageId — возвращает список документов из указанного сообщения
- GetDocumentTypes (V2) — возвращает список типов документов, доступных в ящике
- GetDocumentTypes (V3) — возвращает список типов документов, доступных в ящике, и дату перехода на универсальные сообщения
- MoveDocuments — перемещает документы в указанное подразделение организации
- Restore — восстанавливает документ из удаленных