POST api/SmartRegistry/Reports/eNoteRegistrationRequests/Download

Download a CSV file of eNote Registration requests based on the search criteria.

Request Information

URI Parameters

None.

Body Parameters

The eNote registration report search criteria model.

ESignSystems.SmartSAFE.Models.SmartRegistry.Reports.ENoteRegistrationReportSearchCriteria

Name	Description	Type	Additional information
RegistrationTypeId	Gets or sets the registration type id to search by.	integer	None.
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
StartInitiationDate	Gets or sets a date value. Only registration records that were initiated after this date will return from the search.	date	Required
EndInitiationDate	Gets or sets a date value. Only registration records that were initiated before this date will return from the search.	date	Required
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

Sample:

{
  "RegistrationTypeId": 1,
  "MIN": "sample string 1",
  "DocumentName": "sample string 2",
  "StartInitiationDate": "2024-11-26T17:30:43.9741063-05:00",
  "EndInitiationDate": "2024-11-26T17:30:43.9741063-05:00",
  "ClientId": 1,
  "PageSize": 1,
  "PageOffset": 3
}

application/xml, text/xml

Sample:

<ENoteRegistrationReportSearchCriteria 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>
  <DocumentName>sample string 2</DocumentName>
  <EndInitiationDate>2024-11-26T17:30:43.9741063-05:00</EndInitiationDate>
  <MIN>sample string 1</MIN>
  <RegistrationTypeId>1</RegistrationTypeId>
  <StartInitiationDate>2024-11-26T17:30:43.9741063-05:00</StartInitiationDate>
</ENoteRegistrationReportSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The CSV file of eNote Registration requests.

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>