GET api/Documents/{documentId}/Download?smartDocumentAsPDF={smartDocumentAsPDF}&includeLinkedDocuments={includeLinkedDocuments}&includeAuditCertificate={includeAuditCertificate}&includeAuditLog={includeAuditLog}

Allows a client admin, a SigningRoom admin, or a participant to download the specified document.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
documentId

The document identifier.

 integer

Required
smartDocumentAsPDF

If the document is a smart document, indicates whether to download it as a PDF.

 boolean

None.
includeLinkedDocuments

If set to true includes the linked documents.

 boolean

Default value is False
includeAuditCertificate

If set to true includes the audit certificate.

 boolean

Default value is False
includeAuditLog

If set to true includes the audit log.

 boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

The document.

ESignSystems.SmartSAFE.Models.SigningRoomManager.DownloadDocumentModel
NameDescriptionTypeAdditional information
DocumentId

Gets or sets the document identifier.

 integer

Required
Document

Gets or sets the document to be downloaded.

 Collection of byte

None.
DocumentName

Gets or sets the name of the document to be downloaded.

 string

None.
MimeType

Gets or sets the mime type of the document to be downloaded.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "DocumentId": 1,
  "Document": "QEA=",
  "DocumentName": "sample string 1",
  "MimeType": "sample string 2"
}

application/xml, text/xml

Sample: 
<DownloadDocumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">
  <Document>QEA=</Document>
  <DocumentId>1</DocumentId>
  <DocumentName>sample string 1</DocumentName>
  <MimeType>sample string 2</MimeType>
</DownloadDocumentModel>