5.12 Download Package
5.12.1 Description
The package containing the signed documents can be downloaded by an external system using this call.
The package will be downloaded as .zip file.
Note: The package can only be downloaded if its status is Finished. If the package is in any other state, the request will fail.
5.12.2 URL
https://[servername]:[port]/webportalapi/v3/packages/{id}/download
5.12.3 HTTP Method
GET
5.12.4 Template parameters
Parameter | Occurrence | Content / Description | Type |
---|---|---|---|
id | Required | Unique id for the signing package | String |
5.12.5 Response
The eSignatures API will return a zip file containing all documents. Each file in the zip file will use the value passed in DocumentName, optionally suffixed with a number to keep the filenames unique.
5.12.6 Response codes
Response status code | Description |
---|---|
200 OK | The package gets downloaded successfully. |
404 Not Found | The package cannot be found. |
409 Conflict | The package hasn't been fully signed. |
5.12.7 Error codes
HTTP code | Code |
---|---|
404 | Package.NotFound |
404 | Document.NotFoundInStore |
409 | Package.InvalidStatus |