POST api/ECertification/Search

Searches the eCertifications.

Request Information

URI Parameters

None.

Body Parameters

The eCertification search criteria.

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:21:39.2640899-05:00",
  "EndDate": "2024-11-26T17:21:39.2640899-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:21:39.2640899-05:00</EndDate>
  <InvestorLoanIdentifier>sample string 2</InvestorLoanIdentifier>
  <MIN>sample string 3</MIN>
  <StartDate>2024-11-26T17:21:39.2640899-05:00</StartDate>
</ECertificationSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The list of eCertification models.

Collection of ESignSystems.SmartSAFE.Models.ECertification.ECertificationModel

Name	Description	Type	Additional information
ECertificationId	Gets or sets the eCertification identifier.	integer	None.
CertificationRequestIdentifier	Gets or sets the eCertification request identifier.	string	None.
StartTime	Gets or sets the start date.	date	None.
EndTime	Gets or sets the end date.	date	None.
ECertificationStatusType	Gets or sets the eCertification status type.	string	None.
ResponseStatusCode	Gets or sets the response status code.	string	None.
RequestJSON	Gets or sets the request JSON.	string	None.
ResponseJSON	Gets or sets the response JSON.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ECertificationId": 1,
    "CertificationRequestIdentifier": "sample string 1",
    "StartTime": "2024-11-26T17:21:39.2797513-05:00",
    "EndTime": "2024-11-26T17:21:39.2797513-05:00",
    "ECertificationStatusType": "sample string 3",
    "ResponseStatusCode": "sample string 4",
    "RequestJSON": "sample string 5",
    "ResponseJSON": "sample string 6"
  },
  {
    "ECertificationId": 1,
    "CertificationRequestIdentifier": "sample string 1",
    "StartTime": "2024-11-26T17:21:39.2797513-05:00",
    "EndTime": "2024-11-26T17:21:39.2797513-05:00",
    "ECertificationStatusType": "sample string 3",
    "ResponseStatusCode": "sample string 4",
    "RequestJSON": "sample string 5",
    "ResponseJSON": "sample string 6"
  }
]

application/xml, text/xml

Sample:

<ArrayOfECertificationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.ECertification">
  <ECertificationModel>
    <CertificationRequestIdentifier>sample string 1</CertificationRequestIdentifier>
    <ECertificationId>1</ECertificationId>
    <ECertificationStatusType>sample string 3</ECertificationStatusType>
    <EndTime>2024-11-26T17:21:39.2797513-05:00</EndTime>
    <RequestJSON>sample string 5</RequestJSON>
    <ResponseJSON>sample string 6</ResponseJSON>
    <ResponseStatusCode>sample string 4</ResponseStatusCode>
    <StartTime>2024-11-26T17:21:39.2797513-05:00</StartTime>
  </ECertificationModel>
  <ECertificationModel>
    <CertificationRequestIdentifier>sample string 1</CertificationRequestIdentifier>
    <ECertificationId>1</ECertificationId>
    <ECertificationStatusType>sample string 3</ECertificationStatusType>
    <EndTime>2024-11-26T17:21:39.2797513-05:00</EndTime>
    <RequestJSON>sample string 5</RequestJSON>
    <ResponseJSON>sample string 6</ResponseJSON>
    <ResponseStatusCode>sample string 4</ResponseStatusCode>
    <StartTime>2024-11-26T17:21:39.2797513-05:00</StartTime>
  </ECertificationModel>
</ArrayOfECertificationModel>