GenerateReceiptXml

Обобщённый метод генерации извещений о получении (далее — ИоП) на различные сущности в системе.

POST /GenerateReceiptXml
Query Parameters:
 
  • boxId – идентификатор ящика
  • messageId – идентификатор сообщения
  • attachmentId – идентификатор сущности, для которой требуется сформировать ИоП
Request Headers:
 
Status Codes:
  • 200 OK – операция успешно завершена
  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры
  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization, или в этом заголовке содержатся некорректные авторизационные данные
  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен
  • 405 Method Not Allowed – используется неподходящий HTTP-метод
  • 409 Conflict – формирование ИоПа для данной сущности невозможно
  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка

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

В теле ответа содержится XML-файл ИоПа для сущности attachmentId из сообщения messageId в ящике boxId. На текущий момент в Диадоке можно отправлять ИоПы на следующие сущности:

Тип ИоПа AttachmentType соответствующей сущности Кто шлёт ИоП Кто получает ИоП
На титул отправителя Title (или старый точечный титул отправителя) Получатель документа Отправитель документа
На титул получателя Title (или старый точечный титул получателя) Отправитель Получатель
На уведомление об уточнении InvoiceCorrectionRequest Отправитель Получатель

Для каждого типа документа возможность отправки ИоП задается в свойствах workflow документа: свойства «Извещение о получении титула отправителя», «Извещение о получении титула получателя», «Ответное действие на уведомление об уточнении».

Файл с извещением формируется в соответствии с XML-схемой. Имя файла с извещением передается в стандартном HTTP-заголовке Content-Disposition.

После успешной генерации файла его можно загрузить в систему, передав в методе PostMessagePatch в структуре Receipts.

Предупреждение

Методы GenerateDocumentReceiptXml и GenerateInvoiceDocumentReceiptXml расширены и поддерживают весь функционал нового метода, но считаются устаревшими и не рекомендуются к использованию.