GET api/Folders/{folderId}/Download
Downloads the folder.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| folderId |
The folder identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The folder.
ESignSystems.SmartSAFE.Models.Folders.DownloadFolderModel| Name | Description | Type | Additional information |
|---|---|---|---|
| FolderId |
Gets or sets the folder identifier. |
integer |
None. |
| File |
Gets or sets the file. |
Collection of byte |
None. |
| FileName |
Gets or sets the name of the file. |
string |
None. |
| MimeType |
Gets or sets the mime type of the folder to be downloaded. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"FolderId": 1,
"File": "QEA=",
"FileName": "sample string 1",
"MimeType": "sample string 2"
}
application/xml, text/xml
Sample:
<DownloadFolderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Folders"> <File>QEA=</File> <FileName>sample string 1</FileName> <FolderId>1</FolderId> <MimeType>sample string 2</MimeType> </DownloadFolderModel>