POST api/SmartRegistry/Reports/eNoteTransferRequestsWithoutDocument/Download
Download a CSV file of eNote transfers without a document based on the search criteria.
Request Information
URI Parameters
None.
Body Parameters
Criteria for searching the eNote transfers without a document.
ESignSystems.SmartSAFE.Models.SmartRegistry.Reports.ENoteTransferWithoutDocumentSearchCriteriaName | Description | Type | Additional information |
---|---|---|---|
ClientId |
Gets or sets the client identifier. |
integer |
None. |
ReceivedStartDate |
Gets or sets the received start date. |
date |
Required |
ReceivedEndDate |
Gets or sets the received end date. |
date |
Required |
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
Sample:
{ "ClientId": 1, "ReceivedStartDate": "2024-11-26T17:21:40.0764361-05:00", "ReceivedEndDate": "2024-11-26T17:21:40.0764361-05:00", "PageSize": 1, "PageOffset": 1 }
application/xml, text/xml
Sample:
<ENoteTransferWithoutDocumentSearchCriteria 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">1</PageOffset> <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize> <ClientId>1</ClientId> <ReceivedEndDate>2024-11-26T17:21:40.0764361-05:00</ReceivedEndDate> <ReceivedStartDate>2024-11-26T17:21:40.0764361-05:00</ReceivedStartDate> </ENoteTransferWithoutDocumentSearchCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The CSV file of eNote transfers without a document.
ESignSystems.SmartSAFE.Models.Shared.FileDownloadModelName | 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>