DownloadDocument
Download a specified document.
Input
Name | Type | Required | Accepts Output Streams | Description |
Type | String | True | False | Possible options are envelopes and templates. |
Id | String | True | False | Id of the envelope or template where document stands. |
DocumentId | String | True | False | Id of the document you want do download. |
DownloadLocation | String | True | False | Location of the downloaded file + name of the file + '.pdf'. Ex- C:\Temp\file.pdf |
Encoding | String | False | False | The FileData input encoding type.
The allowed values are NONE, BASE64. The default value is BASE64. |
FileStream | String | False | True | An instance of an output stream where file data is written to. Only used if DownloadPath is not provided. |
Result Set Columns
Name | Type | Description |
Success | String | Returns True if the download succeeded. |
FileData | String | If the DownloadLocation and FileStream are not provided, this contains the content of the file. |