POST api/SmartRegistry/Reports/Batch/Download

Download a CSV file of eRegistry Batch requests based on the search criteria.

Request Information

URI Parameters

None.

Body Parameters

The eRegistry batch search criteria model.

ESignSystems.SmartSAFE.Models.SmartRegistry.Reports.ERegistryBatchSearchCriteria

Name	Description	Type	Additional information
ClientId	Gets or sets the client identifier.	integer	None.
ERegistryBatchId	Gets or sets the eRegistry batch identifier.	integer	None.
MIN	Gets or sets the MIN.	string	None.
RecipientMERSOrgId	Gets or sets the recipient MERS organization identifier.	string	None.
ERegistryBatchStatusTypeId	Gets or sets the eRegistry batch status.	integer	None.
ERegistryBatchTypeId	Gets or sets the ERegistryBatch TypeId	integer	None.
StartDate	Gets or sets the start date.	date	Required
EndDate	Gets or sets the 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,
  "ERegistryBatchId": 1,
  "MIN": "sample string 1",
  "RecipientMERSOrgId": "sample string 2",
  "ERegistryBatchStatusTypeId": 1,
  "ERegistryBatchTypeId": 1,
  "StartDate": "2024-11-26T17:42:47.6399668-05:00",
  "EndDate": "2024-11-26T17:42:47.6399668-05:00",
  "PageSize": 1,
  "PageOffset": 3
}

application/xml, text/xml

Sample:

<ERegistryBatchSearchCriteria 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>
  <ERegistryBatchId>1</ERegistryBatchId>
  <ERegistryBatchStatusTypeId>1</ERegistryBatchStatusTypeId>
  <ERegistryBatchTypeId>1</ERegistryBatchTypeId>
  <EndDate>2024-11-26T17:42:47.6399668-05:00</EndDate>
  <MIN>sample string 1</MIN>
  <RecipientMERSOrgId>sample string 2</RecipientMERSOrgId>
  <StartDate>2024-11-26T17:42:47.6399668-05:00</StartDate>
</ERegistryBatchSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The CSV file of eRegistry batch 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>