POST api/SmartRegistry/Reports/ENoteInventory/Download
Download a CSV file of eNote information retrieved using the search criteria.
Request Information
URI Parameters
None.
Body Parameters
The eNote inventory report search criteria.
ESignSystems.SmartSAFE.Models.Reports.ENoteInventoryReport.ENoteInventoryReportSearchCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientId |
Gets or sets the client identifier. |
integer |
None. |
| StartDate |
Gets or sets the start date. |
date |
Required |
| EndDate |
Gets or sets the end date. |
date |
Required |
Request Formats
application/json, text/json
Sample:
{
"ClientId": 1,
"StartDate": "2024-11-26T17:21:20.6210604-05:00",
"EndDate": "2024-11-26T17:21:20.6210604-05:00"
}
application/xml, text/xml
Sample:
<ENoteInventoryReportSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Reports.ENoteInventoryReport"> <ClientId>1</ClientId> <EndDate>2024-11-26T17:21:20.6210604-05:00</EndDate> <StartDate>2024-11-26T17:21:20.6210604-05:00</StartDate> </ENoteInventoryReportSearchCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The CSV file of eNote information.
ESignSystems.SmartSAFE.Models.Shared.FileDownloadModel| Name | Description | Type | Additional information |
|---|---|---|---|
| File |
Gets or sets the file to be downloaded. |
Collection of byte |
None. |
| FileName |
Gets or sets the name of the file to be downloaded. |
string |
None. |
| MimeType |
Gets or sets the mime type of the file to be downloaded. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"File": "QEA=",
"FileName": "sample string 1",
"MimeType": "sample string 2"
}
application/xml, text/xml
Sample:
<FileDownloadModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Shared"> <File>QEA=</File> <FileName>sample string 1</FileName> <MimeType>sample string 2</MimeType> </FileDownloadModel>