POST api/SmartRegistry/Reports/eRegistryNotifications/Download
Download a CSV file of eRegistry Notifications based on the search criteria.
Request Information
URI Parameters
None.
Body Parameters
The eRegistry notification search criteria model.
ESignSystems.SmartSAFE.Models.SmartRegistry.NotificationSearchCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| MIN |
Gets or sets the MIN to search by. |
string |
Max length: 18 |
| ERegistryRequestTypeId |
Gets or sets the ERegistry request type Id. |
integer |
None. |
| ERegistryNotificationTransactionTypeId |
Gets or sets the eRegistry notification type id. |
integer |
None. |
| StartDate |
Gets or sets a start date value. |
date |
Required |
| EndDate |
Gets or sets an end date value. |
date |
Required |
| TrackingNumber |
Get or sets a tracking number value. |
string |
None. |
| TransferIdentifier |
Get or sets a transfer identifier value. |
string |
None. |
| ClientId |
Gets or sets the client 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",
"ERegistryRequestTypeId": 1,
"ERegistryNotificationTransactionTypeId": 1,
"StartDate": "2025-11-04T12:34:42.6746317-05:00",
"EndDate": "2025-11-04T12:34:42.6746317-05:00",
"TrackingNumber": "sample string 2",
"TransferIdentifier": "sample string 3",
"ClientId": 1,
"PageSize": 1,
"PageOffset": 4
}
application/xml, text/xml
<NotificationSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry"> <PageOffset xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">4</PageOffset> <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize> <ClientId>1</ClientId> <ERegistryNotificationTransactionTypeId>1</ERegistryNotificationTransactionTypeId> <ERegistryRequestTypeId>1</ERegistryRequestTypeId> <EndDate>2025-11-04T12:34:42.6746317-05:00</EndDate> <MIN>sample string 1</MIN> <StartDate>2025-11-04T12:34:42.6746317-05:00</StartDate> <TrackingNumber>sample string 2</TrackingNumber> <TransferIdentifier>sample string 3</TransferIdentifier> </NotificationSearchCriteria>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The CSV file of eRegistry Notifications.
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>