POST api/SmartRegistry/Reports/eRegistryTransactions/Download
Download a CSV file of eRegistry Transactions based on the search criteria.
Request Information
URI Parameters
None.
Body Parameters
The eRegistry transaction search criteria model.
ESignSystems.SmartSAFE.Models.SmartRegistry.Reports.ERegistryTransactionSearchCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| StartDate |
Gets or sets the start date to filter by. |
date |
Required |
| EndDate |
Gets or sets the end date to filter by. |
date |
Required |
| MIN |
Gets or sets the MIN. |
string |
None. |
| ERegistryRequestTypeId |
Gets or sets the request type id. |
integer |
None. |
| ERegistryTransactionRequestTypeId |
Gets or sets the transaction request type id. |
integer |
None. |
| ERegistryRequestActionTypeId |
Gets or sets the request action type id. |
integer |
None. |
| ERegistryConfirmationTypeId |
Gets or sets the confirmation type id. |
integer |
None. |
| ERegistryNotificationTransactionTypeId |
Gets or sets the notification transaction type id. |
integer |
None. |
| ClientId |
Gets or sets the client identifier. |
integer |
None. |
| TransferIdentifier |
Gets or sets the transfer identifier. |
string |
Max length: 256 |
| TrackingNumber |
Get or sets a tracking number value. |
string |
Max length: 256 |
| ERegistryRequestSubActionType |
Gets or sets the request sub action type. |
string |
None. |
| MINs |
Gets or sets the list of MINs. |
Collection of string |
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
{
"StartDate": "2025-12-14T18:32:56.235577-08:00",
"EndDate": "2025-12-14T18:32:56.235577-08:00",
"MIN": "sample string 1",
"ERegistryRequestTypeId": 1,
"ERegistryTransactionRequestTypeId": 1,
"ERegistryRequestActionTypeId": 1,
"ERegistryConfirmationTypeId": 1,
"ERegistryNotificationTransactionTypeId": 1,
"ClientId": 1,
"TransferIdentifier": "sample string 2",
"TrackingNumber": "sample string 3",
"ERegistryRequestSubActionType": "sample string 4",
"MINs": [
"sample string 1",
"sample string 2"
],
"PageSize": 1,
"PageOffset": 5
}
application/xml, text/xml
<ERegistryTransactionSearchCriteria 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">5</PageOffset>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
<ClientId>1</ClientId>
<ERegistryConfirmationTypeId>1</ERegistryConfirmationTypeId>
<ERegistryNotificationTransactionTypeId>1</ERegistryNotificationTransactionTypeId>
<ERegistryRequestActionTypeId>1</ERegistryRequestActionTypeId>
<ERegistryRequestSubActionType>sample string 4</ERegistryRequestSubActionType>
<ERegistryRequestTypeId>1</ERegistryRequestTypeId>
<ERegistryTransactionRequestTypeId>1</ERegistryTransactionRequestTypeId>
<EndDate>2025-12-14T18:32:56.235577-08:00</EndDate>
<MIN>sample string 1</MIN>
<MINs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</MINs>
<StartDate>2025-12-14T18:32:56.235577-08:00</StartDate>
<TrackingNumber>sample string 3</TrackingNumber>
<TransferIdentifier>sample string 2</TransferIdentifier>
</ERegistryTransactionSearchCriteria>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The CSV file of eRegistry transactions.
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>