POST api/Documents/DownloadAsZip

Downloads multiple files into a zip.

Request Information

URI Parameters

None.

Body Parameters

The document ids.

Collection of integer

Request Formats

application/json, text/json

Sample:

[
  1,
  2
]

application/xml, text/xml

Sample:

<ArrayOflong xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <long>1</long>
  <long>2</long>
</ArrayOflong>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The zipped documents.

ESignSystems.SmartSAFE.Models.Documents.DownloadDocumentsModel

Name	Description	Type	Additional information
DocumentIds	Gets or sets the document ids.	Collection of integer	None.
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:

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

application/xml, text/xml

Sample:

<DownloadDocumentsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Documents">
  <Document>QEA=</Document>
  <DocumentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </DocumentIds>
  <DocumentName>sample string 1</DocumentName>
  <MimeType>sample string 2</MimeType>
</DownloadDocumentsModel>