POST api/SmartRegistry/Reports/eDelivery

Performs an eDelivery Request search based on the search criteria.

Request Information

URI Parameters

None.

Body Parameters

The search criteria.

ESignSystems.SmartSAFE.Models.SmartRegistry.Reports.EDeliveryRequestSearchCriteria
NameDescriptionTypeAdditional information
TrackingNumber

Gets or sets the tracking number.

 string

None.
ClientId

Gets or sets the client identifier.

 integer

None.
DocumentName

Gets or sets the document name.

 string

None.
MIN

Gets or sets the min.

 string

None.
StartDate

Gets or sets the start date.

 date

Required
EndDate

Gets or sets the end date.

 date

Required
ERegistryTransactionRequestTypeId

Gets or sets the eRegistryTransactionRequestTypeId.

 integer

None.
ERegistryRequestStatusTypeId

Gets or sets the eRegistryRequestStatusTypeId.

 integer

None.
ERegistryBatchId

Gets or sets the eRegistry batch 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: 
{
  "TrackingNumber": "sample string 1",
  "ClientId": 1,
  "DocumentName": "sample string 2",
  "MIN": "sample string 3",
  "StartDate": "2024-11-26T13:31:25.133563-05:00",
  "EndDate": "2024-11-26T13:31:25.133563-05:00",
  "ERegistryTransactionRequestTypeId": 1,
  "ERegistryRequestStatusTypeId": 1,
  "ERegistryBatchId": 1,
  "PageSize": 1,
  "PageOffset": 4
}

application/xml, text/xml

Sample: 
<EDeliveryRequestSearchCriteria 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">4</PageOffset>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
  <ClientId>1</ClientId>
  <DocumentName>sample string 2</DocumentName>
  <ERegistryBatchId>1</ERegistryBatchId>
  <ERegistryRequestStatusTypeId>1</ERegistryRequestStatusTypeId>
  <ERegistryTransactionRequestTypeId>1</ERegistryTransactionRequestTypeId>
  <EndDate>2024-11-26T13:31:25.133563-05:00</EndDate>
  <MIN>sample string 3</MIN>
  <StartDate>2024-11-26T13:31:25.133563-05:00</StartDate>
  <TrackingNumber>sample string 1</TrackingNumber>
</EDeliveryRequestSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The list of eDelivery Request search results.

Collection of ESignSystems.SmartSAFE.Models.SmartRegistry.Reports.EDeliveryRequestModel
NameDescriptionTypeAdditional information
ClientId

Gets or sets the client identifier.

 integer

None.
MINs

Gets or sets the MINs.

 string

None.
TrackingNumber

Gets or sets the tracking number.

 string

None.
Recipient

Gets or sets the recipient.

 string

None.
RequestType

Gets or sets the request type.

 string

None.
ConfirmationType

Gets or sets the confirmation type.

 string

None.
CurrentStatus

Gets or sets the current status.

 string

None.
InitiatedBy

Gets or sets the initiated by value.

 string

None.
InitiatedReceivedDate

For an initiation request record, gets or sets the initiated date. For a notification record, gets or sets the received date of the initial pending notification.

 date

None.
RespondedBy

Gets or sets the responded by value.

 string

None.
RespondedDate

Gets or sets the responded date.

 date

None.
RequestStatus

Gets or sets the request status.

 string

None.
DistributionApprovalType

Gets or sets the type of the distribution approval.

 string

None.
ReceivedFrom

Gets or sets the MERS org that this request was received from.

 string

None.
ERegistryBatchId

Gets or sets the eRegistry batch identifier.

 integer

None.
EDeliveryRecipientMERSOrgId

Gets the eDelivery recipient MERS organization identifier.

 string

None.
StatusDescription

Gets or sets the status description.

 string

None.
LoanNumber

Gets or sets the loan number/identifier.

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "ClientId": 1,
    "MINs": "sample string 1",
    "TrackingNumber": "sample string 2",
    "Recipient": "sample string 3",
    "RequestType": "sample string 4",
    "ConfirmationType": "sample string 5",
    "CurrentStatus": "sample string 6",
    "InitiatedBy": "sample string 7",
    "InitiatedReceivedDate": "2024-11-26T13:31:25.1491712-05:00",
    "RespondedBy": "sample string 8",
    "RespondedDate": "2024-11-26T13:31:25.1491712-05:00",
    "RequestStatus": "sample string 9",
    "DistributionApprovalType": "sample string 10",
    "ReceivedFrom": "sample string 11",
    "ERegistryBatchId": 1,
    "EDeliveryRecipientMERSOrgId": "sample string 12",
    "StatusDescription": "sample string 13",
    "LoanNumber": "sample string 14"
  },
  {
    "ClientId": 1,
    "MINs": "sample string 1",
    "TrackingNumber": "sample string 2",
    "Recipient": "sample string 3",
    "RequestType": "sample string 4",
    "ConfirmationType": "sample string 5",
    "CurrentStatus": "sample string 6",
    "InitiatedBy": "sample string 7",
    "InitiatedReceivedDate": "2024-11-26T13:31:25.1491712-05:00",
    "RespondedBy": "sample string 8",
    "RespondedDate": "2024-11-26T13:31:25.1491712-05:00",
    "RequestStatus": "sample string 9",
    "DistributionApprovalType": "sample string 10",
    "ReceivedFrom": "sample string 11",
    "ERegistryBatchId": 1,
    "EDeliveryRecipientMERSOrgId": "sample string 12",
    "StatusDescription": "sample string 13",
    "LoanNumber": "sample string 14"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfEDeliveryRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry.Reports">
  <EDeliveryRequestModel>
    <ClientId>1</ClientId>
    <ConfirmationType>sample string 5</ConfirmationType>
    <CurrentStatus>sample string 6</CurrentStatus>
    <DistributionApprovalType>sample string 10</DistributionApprovalType>
    <EDeliveryRecipientMERSOrgId>sample string 12</EDeliveryRecipientMERSOrgId>
    <ERegistryBatchId>1</ERegistryBatchId>
    <InitiatedBy>sample string 7</InitiatedBy>
    <InitiatedReceivedDate>2024-11-26T13:31:25.1491712-05:00</InitiatedReceivedDate>
    <LoanNumber>sample string 14</LoanNumber>
    <MINs>sample string 1</MINs>
    <ReceivedFrom>sample string 11</ReceivedFrom>
    <Recipient>sample string 3</Recipient>
    <RequestStatus>sample string 9</RequestStatus>
    <RequestType>sample string 4</RequestType>
    <RespondedBy>sample string 8</RespondedBy>
    <RespondedDate>2024-11-26T13:31:25.1491712-05:00</RespondedDate>
    <StatusDescription>sample string 13</StatusDescription>
    <TrackingNumber>sample string 2</TrackingNumber>
  </EDeliveryRequestModel>
  <EDeliveryRequestModel>
    <ClientId>1</ClientId>
    <ConfirmationType>sample string 5</ConfirmationType>
    <CurrentStatus>sample string 6</CurrentStatus>
    <DistributionApprovalType>sample string 10</DistributionApprovalType>
    <EDeliveryRecipientMERSOrgId>sample string 12</EDeliveryRecipientMERSOrgId>
    <ERegistryBatchId>1</ERegistryBatchId>
    <InitiatedBy>sample string 7</InitiatedBy>
    <InitiatedReceivedDate>2024-11-26T13:31:25.1491712-05:00</InitiatedReceivedDate>
    <LoanNumber>sample string 14</LoanNumber>
    <MINs>sample string 1</MINs>
    <ReceivedFrom>sample string 11</ReceivedFrom>
    <Recipient>sample string 3</Recipient>
    <RequestStatus>sample string 9</RequestStatus>
    <RequestType>sample string 4</RequestType>
    <RespondedBy>sample string 8</RespondedBy>
    <RespondedDate>2024-11-26T13:31:25.1491712-05:00</RespondedDate>
    <StatusDescription>sample string 13</StatusDescription>
    <TrackingNumber>sample string 2</TrackingNumber>
  </EDeliveryRequestModel>
</ArrayOfEDeliveryRequestModel>