POST api/SmartRegistry/Reports/eNoteTransferRequests/Download
Download a file of eNote transfer requests based on the search criteria.
Request Information
URI Parameters
None.
Body Parameters
The search criteria.
ESignSystems.SmartSAFE.Models.SmartRegistry.Reports.ENoteTransferReportSearchCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| MIN |
Gets or sets the MIN to search by. |
string |
Max length: 18 |
| DocumentName |
Gets or sets the document name to search by. |
string |
Max length: 150 |
| StartDate |
Gets or sets a date value. Transfer requests that were initiated after this date and transfer notification that were received after this date will return from the search. |
date |
Required |
| EndDate |
Gets or sets a date value. Transfer requests that were initiated before this date and transfer notification that were received before this date will return from the search. |
date |
Required |
| RequestActionTypeId |
Gets or sets the request action type id to search by. |
integer |
None. |
| CurrentStatusId |
Gets or sets the current status id to search by. |
integer |
None. |
| ClientId |
Gets or sets the client identifier. |
integer |
None. |
| ERegistryBatchId |
Gets or sets the eRegistry batch identifier. |
integer |
None. |
| PageSize |
Gets or sets the number of rows in the page. |
integer |
Range: inclusive between 1 and 2147483647 |
| PageOffset |
Gets or sets the offset page to return. |
integer |
None. |
Request Formats
application/json, text/json
{
"MIN": "sample string 1",
"DocumentName": "sample string 2",
"StartDate": "2025-12-12T21:07:03.7626618-05:00",
"EndDate": "2025-12-12T21:07:03.7626618-05:00",
"RequestActionTypeId": 1,
"CurrentStatusId": 1,
"ClientId": 1,
"ERegistryBatchId": 1,
"PageSize": 1,
"PageOffset": 3
}
application/xml, text/xml
<ENoteTransferReportSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry.Reports"> <PageOffset xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">3</PageOffset> <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize> <ClientId>1</ClientId> <CurrentStatusId>1</CurrentStatusId> <DocumentName>sample string 2</DocumentName> <ERegistryBatchId>1</ERegistryBatchId> <EndDate>2025-12-12T21:07:03.7626618-05:00</EndDate> <MIN>sample string 1</MIN> <RequestActionTypeId>1</RequestActionTypeId> <StartDate>2025-12-12T21:07:03.7626618-05:00</StartDate> </ENoteTransferReportSearchCriteria>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The file of transfer requests that match the search criteria.
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
{
"File": "QEA=",
"FileName": "sample string 1",
"MimeType": "sample string 2"
}
application/xml, text/xml
<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>