POST api/ECertification/Download

Download a CSV file of eCertifications based on the search criteria.

Request Information

URI Parameters

None.

Body Parameters

The eCertification search criteria model.

ESignSystems.SmartSAFE.Models.ECertification.ECertificationSearchCriteria

Name	Description	Type	Additional information
CertificationRequestIdentifier	Gets or sets the eCertification request identifier.	string	Max length: 64
ECertificationStatusTypeId	Gets or sets the eCertification status type identifier.	integer	None.
CertifiedStatusTypeId	Gets or sets the certified status type identifier.	integer	None.
InvestorLoanIdentifier	Gets or sets the investor loan identifier.	string	Max length: 30
MIN	Gets or sets the MIN.	string	Max length: 18
ClientId	Gets or sets the client identifier.	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:

{
  "CertificationRequestIdentifier": "sample string 1",
  "ECertificationStatusTypeId": 1,
  "CertifiedStatusTypeId": 1,
  "InvestorLoanIdentifier": "sample string 2",
  "MIN": "sample string 3",
  "ClientId": 1,
  "StartDate": "2024-11-26T17:28:21.1416551-05:00",
  "EndDate": "2024-11-26T17:28:21.1416551-05:00",
  "PageSize": 1,
  "PageOffset": 4
}

application/xml, text/xml

Sample:

<ECertificationSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.ECertification">
  <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>
  <CertificationRequestIdentifier>sample string 1</CertificationRequestIdentifier>
  <CertifiedStatusTypeId>1</CertifiedStatusTypeId>
  <ClientId>1</ClientId>
  <ECertificationStatusTypeId>1</ECertificationStatusTypeId>
  <EndDate>2024-11-26T17:28:21.1416551-05:00</EndDate>
  <InvestorLoanIdentifier>sample string 2</InvestorLoanIdentifier>
  <MIN>sample string 3</MIN>
  <StartDate>2024-11-26T17:28:21.1416551-05:00</StartDate>
</ECertificationSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A CSV file of eCertifications.

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>