POST api/SmartRegistry/Reports/ChangeStatus

Performs an eRegistry Change Status transaction search based on the search criteria.

Request Information

URI Parameters

None.

Body Parameters

Criteria for searching the eRegistry transactions.

ESignSystems.SmartSAFE.Models.SmartRegistry.Reports.ERegistryTransactionSearchCriteria
NameDescriptionTypeAdditional information
StartDate

Gets or sets the start date to filter by.

 date

Required
EndDate

Gets or sets the end date to filter by.

 date

Required
MIN

Gets or sets the MIN.

 string

None.
ERegistryRequestTypeId

Gets or sets the request type id.

 integer

None.
ERegistryTransactionRequestTypeId

Gets or sets the transaction request type id.

 integer

None.
ERegistryRequestActionTypeId

Gets or sets the request action type id.

 integer

None.
ERegistryConfirmationTypeId

Gets or sets the confirmation type id.

 integer

None.
ERegistryNotificationTransactionTypeId

Gets or sets the notification transaction type id.

 integer

None.
ClientId

Gets or sets the client identifier.

 integer

None.
TransferIdentifier

Gets or sets the transfer identifier.

 string

Max length: 256
TrackingNumber

Get or sets a tracking number value.

 string

Max length: 256
ERegistryRequestSubActionType

Gets or sets the request sub action type.

 string

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: 
{
  "StartDate": "2024-11-26T17:25:35.9071157-05:00",
  "EndDate": "2024-11-26T17:25:35.9071157-05:00",
  "MIN": "sample string 1",
  "ERegistryRequestTypeId": 1,
  "ERegistryTransactionRequestTypeId": 1,
  "ERegistryRequestActionTypeId": 1,
  "ERegistryConfirmationTypeId": 1,
  "ERegistryNotificationTransactionTypeId": 1,
  "ClientId": 1,
  "TransferIdentifier": "sample string 2",
  "TrackingNumber": "sample string 3",
  "ERegistryRequestSubActionType": "sample string 4",
  "PageSize": 1,
  "PageOffset": 5
}

application/xml, text/xml

Sample: 
<ERegistryTransactionSearchCriteria 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">5</PageOffset>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
  <ClientId>1</ClientId>
  <ERegistryConfirmationTypeId>1</ERegistryConfirmationTypeId>
  <ERegistryNotificationTransactionTypeId>1</ERegistryNotificationTransactionTypeId>
  <ERegistryRequestActionTypeId>1</ERegistryRequestActionTypeId>
  <ERegistryRequestSubActionType>sample string 4</ERegistryRequestSubActionType>
  <ERegistryRequestTypeId>1</ERegistryRequestTypeId>
  <ERegistryTransactionRequestTypeId>1</ERegistryTransactionRequestTypeId>
  <EndDate>2024-11-26T17:25:35.9071157-05:00</EndDate>
  <MIN>sample string 1</MIN>
  <StartDate>2024-11-26T17:25:35.9071157-05:00</StartDate>
  <TrackingNumber>sample string 3</TrackingNumber>
  <TransferIdentifier>sample string 2</TransferIdentifier>
</ERegistryTransactionSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of the eRegistry transactions.

Collection of ESignSystems.SmartSAFE.Models.SmartRegistry.Reports.ERegistryTransactionModel
NameDescriptionTypeAdditional information
MIN

Gets or sets the MIN.

 string

None.
CEMAMIN

Gets or sets the CEMA MIN.

 string

None.
LoanIdentifier

Gets or sets the loan identifier.

 string

None.
DocumentName

Gets or sets the document name.

 string

None.
DocumentId

Gets or sets the document id.

 integer

None.
SigningRoomId

Gets or sets the signing room id.

 integer

None.
RelatedDocument

Gets or sets the related document.

 string

None.
DocumentType

Gets or sets the document type.

 string

None.
RequestType

Gets or sets the request type.

 string

None.
TransactionRequestType

Gets or sets the transaction request type which can be an initiation or a confirmation.

 string

None.
ActionType

Gets or sets the action type.

 string

None.
ActionSubType

Gets or sets the action sub type.

 string

None.
RegistrationMethod

Gets or sets the registration method.

 string

None.
DistributionApprovalType

Gets or sets the distribution approval type.

 string

None.
ConfirmationType

Gets or sets the confirmation type.

 string

None.
NotificationType

Gets or sets the notification type.

 string

None.
TransactionIdentifier

Gets or sets the transaction identifier.

 string

None.
TransferIdentifier

Gets or sets the transfer identifier.

 string

None.
TrackingNumber

Gets or sets the tracking number.

 string

None.
RequestStatus

Gets or sets the request status.

 string

None.
InitiatedBy

Gets or sets who initiated the request.

 string

None.
InitiatedDate

Gets or sets the date the request was initiated.

 date

None.
ResponseReceivedDate

Gets or sets the date the response was received.

 date

None.
UpdatedDate

Gets or sets the date the transaction row was updated.

 date

None.
ClientName

Gets or sets the client name.

 string

None.
CurrentStatus

Gets or sets the current status.

 string

None.
StatusDescription

Gets or sets the status description.

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "MIN": "sample string 1",
    "CEMAMIN": "sample string 2",
    "LoanIdentifier": "sample string 3",
    "DocumentName": "sample string 4",
    "DocumentId": 1,
    "SigningRoomId": 1,
    "RelatedDocument": "sample string 5",
    "DocumentType": "sample string 6",
    "RequestType": "sample string 7",
    "TransactionRequestType": "sample string 8",
    "ActionType": "sample string 9",
    "ActionSubType": "sample string 10",
    "RegistrationMethod": "sample string 11",
    "DistributionApprovalType": "sample string 12",
    "ConfirmationType": "sample string 13",
    "NotificationType": "sample string 14",
    "TransactionIdentifier": "sample string 15",
    "TransferIdentifier": "sample string 16",
    "TrackingNumber": "sample string 17",
    "RequestStatus": "sample string 18",
    "InitiatedBy": "sample string 19",
    "InitiatedDate": "2024-11-26T17:25:35.9071157-05:00",
    "ResponseReceivedDate": "2024-11-26T17:25:35.9071157-05:00",
    "UpdatedDate": "2024-11-26T17:25:35.9071157-05:00",
    "ClientName": "sample string 20",
    "CurrentStatus": "sample string 21",
    "StatusDescription": "sample string 22"
  },
  {
    "MIN": "sample string 1",
    "CEMAMIN": "sample string 2",
    "LoanIdentifier": "sample string 3",
    "DocumentName": "sample string 4",
    "DocumentId": 1,
    "SigningRoomId": 1,
    "RelatedDocument": "sample string 5",
    "DocumentType": "sample string 6",
    "RequestType": "sample string 7",
    "TransactionRequestType": "sample string 8",
    "ActionType": "sample string 9",
    "ActionSubType": "sample string 10",
    "RegistrationMethod": "sample string 11",
    "DistributionApprovalType": "sample string 12",
    "ConfirmationType": "sample string 13",
    "NotificationType": "sample string 14",
    "TransactionIdentifier": "sample string 15",
    "TransferIdentifier": "sample string 16",
    "TrackingNumber": "sample string 17",
    "RequestStatus": "sample string 18",
    "InitiatedBy": "sample string 19",
    "InitiatedDate": "2024-11-26T17:25:35.9071157-05:00",
    "ResponseReceivedDate": "2024-11-26T17:25:35.9071157-05:00",
    "UpdatedDate": "2024-11-26T17:25:35.9071157-05:00",
    "ClientName": "sample string 20",
    "CurrentStatus": "sample string 21",
    "StatusDescription": "sample string 22"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfERegistryTransactionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry.Reports">
  <ERegistryTransactionModel>
    <ActionSubType>sample string 10</ActionSubType>
    <ActionType>sample string 9</ActionType>
    <CEMAMIN>sample string 2</CEMAMIN>
    <ClientName>sample string 20</ClientName>
    <ConfirmationType>sample string 13</ConfirmationType>
    <CurrentStatus>sample string 21</CurrentStatus>
    <DistributionApprovalType>sample string 12</DistributionApprovalType>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 4</DocumentName>
    <DocumentType>sample string 6</DocumentType>
    <InitiatedBy>sample string 19</InitiatedBy>
    <InitiatedDate>2024-11-26T17:25:35.9071157-05:00</InitiatedDate>
    <LoanIdentifier>sample string 3</LoanIdentifier>
    <MIN>sample string 1</MIN>
    <NotificationType>sample string 14</NotificationType>
    <RegistrationMethod>sample string 11</RegistrationMethod>
    <RelatedDocument>sample string 5</RelatedDocument>
    <RequestStatus>sample string 18</RequestStatus>
    <RequestType>sample string 7</RequestType>
    <ResponseReceivedDate>2024-11-26T17:25:35.9071157-05:00</ResponseReceivedDate>
    <SigningRoomId>1</SigningRoomId>
    <StatusDescription>sample string 22</StatusDescription>
    <TrackingNumber>sample string 17</TrackingNumber>
    <TransactionIdentifier>sample string 15</TransactionIdentifier>
    <TransactionRequestType>sample string 8</TransactionRequestType>
    <TransferIdentifier>sample string 16</TransferIdentifier>
    <UpdatedDate>2024-11-26T17:25:35.9071157-05:00</UpdatedDate>
  </ERegistryTransactionModel>
  <ERegistryTransactionModel>
    <ActionSubType>sample string 10</ActionSubType>
    <ActionType>sample string 9</ActionType>
    <CEMAMIN>sample string 2</CEMAMIN>
    <ClientName>sample string 20</ClientName>
    <ConfirmationType>sample string 13</ConfirmationType>
    <CurrentStatus>sample string 21</CurrentStatus>
    <DistributionApprovalType>sample string 12</DistributionApprovalType>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 4</DocumentName>
    <DocumentType>sample string 6</DocumentType>
    <InitiatedBy>sample string 19</InitiatedBy>
    <InitiatedDate>2024-11-26T17:25:35.9071157-05:00</InitiatedDate>
    <LoanIdentifier>sample string 3</LoanIdentifier>
    <MIN>sample string 1</MIN>
    <NotificationType>sample string 14</NotificationType>
    <RegistrationMethod>sample string 11</RegistrationMethod>
    <RelatedDocument>sample string 5</RelatedDocument>
    <RequestStatus>sample string 18</RequestStatus>
    <RequestType>sample string 7</RequestType>
    <ResponseReceivedDate>2024-11-26T17:25:35.9071157-05:00</ResponseReceivedDate>
    <SigningRoomId>1</SigningRoomId>
    <StatusDescription>sample string 22</StatusDescription>
    <TrackingNumber>sample string 17</TrackingNumber>
    <TransactionIdentifier>sample string 15</TransactionIdentifier>
    <TransactionRequestType>sample string 8</TransactionRequestType>
    <TransferIdentifier>sample string 16</TransferIdentifier>
    <UpdatedDate>2024-11-26T17:25:35.9071157-05:00</UpdatedDate>
  </ERegistryTransactionModel>
</ArrayOfERegistryTransactionModel>