POST api/Signing/{signingRoomId}/Documents/Download

Downloads the specified list of document from the specified SigningRoom. The current signer user must have access to the SigningRoom that contains the document and must have sign privileges on the document.

Request Information

URI Parameters

Name	Description	Type	Additional information
signingRoomId	The id of the SigningRoom.	integer	Required

Body Parameters

The list of documents to be downloaded.

Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.DownloadDocumentModel

Name	Description	Type	Additional 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.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The list of downloaded documents.

Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.DownloadDocumentModel

Name	Description	Type	Additional 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"
  },
  {
    "DocumentId": 1,
    "Document": "QEA=",
    "DocumentName": "sample string 1",
    "MimeType": "sample string 2"
  }
]

application/xml, text/xml

Sample:

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