POST api/SmartRegistry/Reports/eRegistryNotifications

Provides the ability to search for eRegistry notifications.

Request Information

URI Parameters

None.

Body Parameters

The eRegistry notification search criteria.

ESignSystems.SmartSAFE.Models.SmartRegistry.NotificationSearchCriteria
NameDescriptionTypeAdditional information
MIN

Gets or sets the MIN to search by.

 string

Max length: 18
ERegistryRequestTypeId

Gets or sets the ERegistry request type Id.

 integer

None.
ERegistryNotificationTransactionTypeId

Gets or sets the eRegistry notification type id.

 integer

None.
StartDate

Gets or sets a start date value.

 date

Required
EndDate

Gets or sets an end date value.

 date

Required
TrackingNumber

Get or sets a tracking number value.

 string

None.
TransferIdentifier

Get or sets a transfer identifier value.

 string

None.
ClientId

Gets or sets the client 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: 
{
  "MIN": "sample string 1",
  "ERegistryRequestTypeId": 1,
  "ERegistryNotificationTransactionTypeId": 1,
  "StartDate": "2024-11-26T17:38:18.2644737-05:00",
  "EndDate": "2024-11-26T17:38:18.2644737-05:00",
  "TrackingNumber": "sample string 2",
  "TransferIdentifier": "sample string 3",
  "ClientId": 1,
  "PageSize": 1,
  "PageOffset": 4
}

application/xml, text/xml

Sample: 
<NotificationSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry">
  <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>
  <ERegistryNotificationTransactionTypeId>1</ERegistryNotificationTransactionTypeId>
  <ERegistryRequestTypeId>1</ERegistryRequestTypeId>
  <EndDate>2024-11-26T17:38:18.2644737-05:00</EndDate>
  <MIN>sample string 1</MIN>
  <StartDate>2024-11-26T17:38:18.2644737-05:00</StartDate>
  <TrackingNumber>sample string 2</TrackingNumber>
  <TransferIdentifier>sample string 3</TransferIdentifier>
</NotificationSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The list of eRegistry notifications.

Collection of ESignSystems.SmartSAFE.Models.SmartRegistry.NotificationModel
NameDescriptionTypeAdditional information
ERegistryNotificationId

Gets or sets the eRegistry notification id.

 integer

None.
ClientId

Gets or sets the client id of the registration request.

 integer

None.
MIN

Gets or sets the MIN.

 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.
RequestingPartyOrgId

Gets or sets the requesting party org id.

 string

None.
RequestingPartyOrg

Gets or sets the requesting party org.

 string

None.
ERegistryRequestTypeId

Gets or sets the eRegistry request type id.

 integer

None.
ERegistryRequestType

Gets or sets the eRegistry request type.

 string

None.
ERegistryRequestActionTypeId

Gets or sets the eRegistry request action type id.

 integer

None.
ERegistryRequestActionType

Gets or sets the eRegistry request action type.

 string

None.
ERegistryNotificationType

Gets or sets the eRegistry notification type.

 string

None.
ERegistryConfirmationType

Gets or sets the eRegistry confirmation type.

 string

None.
UserResponse

Gets or sets the user response.

 string

None.
ReceivedDate

Gets or sets the received date.

 date

None.
ActionEffectiveDate

Gets or sets the action effective date.

 date

None.
TrackingNumber

Gets or sets the tracking number.

 string

None.
TransferIdentifier

Gets or sets the transaction identifier.

 string

None.
RespondedBy

Gets or sets the user name of the user who responded to the notification.

 string

None.
RespondedDate

Gets or sets the date and time of when the notification was responded to.

 date

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "ERegistryNotificationId": 1,
    "ClientId": 2,
    "MIN": "sample string 3",
    "DocumentName": "sample string 4",
    "DocumentId": 1,
    "SigningRoomId": 1,
    "RequestingPartyOrgId": "sample string 5",
    "RequestingPartyOrg": "sample string 6",
    "ERegistryRequestTypeId": 7,
    "ERegistryRequestType": "sample string 8",
    "ERegistryRequestActionTypeId": 9,
    "ERegistryRequestActionType": "sample string 10",
    "ERegistryNotificationType": "sample string 11",
    "ERegistryConfirmationType": "sample string 12",
    "UserResponse": "sample string 13",
    "ReceivedDate": "2024-11-26T17:38:18.2644737-05:00",
    "ActionEffectiveDate": "2024-11-26T17:38:18.2644737-05:00",
    "TrackingNumber": "sample string 14",
    "TransferIdentifier": "sample string 15",
    "RespondedBy": "sample string 16",
    "RespondedDate": "2024-11-26T17:38:18.2644737-05:00"
  },
  {
    "ERegistryNotificationId": 1,
    "ClientId": 2,
    "MIN": "sample string 3",
    "DocumentName": "sample string 4",
    "DocumentId": 1,
    "SigningRoomId": 1,
    "RequestingPartyOrgId": "sample string 5",
    "RequestingPartyOrg": "sample string 6",
    "ERegistryRequestTypeId": 7,
    "ERegistryRequestType": "sample string 8",
    "ERegistryRequestActionTypeId": 9,
    "ERegistryRequestActionType": "sample string 10",
    "ERegistryNotificationType": "sample string 11",
    "ERegistryConfirmationType": "sample string 12",
    "UserResponse": "sample string 13",
    "ReceivedDate": "2024-11-26T17:38:18.2644737-05:00",
    "ActionEffectiveDate": "2024-11-26T17:38:18.2644737-05:00",
    "TrackingNumber": "sample string 14",
    "TransferIdentifier": "sample string 15",
    "RespondedBy": "sample string 16",
    "RespondedDate": "2024-11-26T17:38:18.2644737-05:00"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfNotificationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry">
  <NotificationModel>
    <ActionEffectiveDate>2024-11-26T17:38:18.2644737-05:00</ActionEffectiveDate>
    <ClientId>2</ClientId>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 4</DocumentName>
    <ERegistryConfirmationType>sample string 12</ERegistryConfirmationType>
    <ERegistryNotificationId>1</ERegistryNotificationId>
    <ERegistryNotificationType>sample string 11</ERegistryNotificationType>
    <ERegistryRequestActionType>sample string 10</ERegistryRequestActionType>
    <ERegistryRequestActionTypeId>9</ERegistryRequestActionTypeId>
    <ERegistryRequestType>sample string 8</ERegistryRequestType>
    <ERegistryRequestTypeId>7</ERegistryRequestTypeId>
    <MIN>sample string 3</MIN>
    <ReceivedDate>2024-11-26T17:38:18.2644737-05:00</ReceivedDate>
    <RequestingPartyOrg>sample string 6</RequestingPartyOrg>
    <RequestingPartyOrgId>sample string 5</RequestingPartyOrgId>
    <RespondedBy>sample string 16</RespondedBy>
    <RespondedDate>2024-11-26T17:38:18.2644737-05:00</RespondedDate>
    <SigningRoomId>1</SigningRoomId>
    <TrackingNumber>sample string 14</TrackingNumber>
    <TransferIdentifier>sample string 15</TransferIdentifier>
    <UserResponse>sample string 13</UserResponse>
  </NotificationModel>
  <NotificationModel>
    <ActionEffectiveDate>2024-11-26T17:38:18.2644737-05:00</ActionEffectiveDate>
    <ClientId>2</ClientId>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 4</DocumentName>
    <ERegistryConfirmationType>sample string 12</ERegistryConfirmationType>
    <ERegistryNotificationId>1</ERegistryNotificationId>
    <ERegistryNotificationType>sample string 11</ERegistryNotificationType>
    <ERegistryRequestActionType>sample string 10</ERegistryRequestActionType>
    <ERegistryRequestActionTypeId>9</ERegistryRequestActionTypeId>
    <ERegistryRequestType>sample string 8</ERegistryRequestType>
    <ERegistryRequestTypeId>7</ERegistryRequestTypeId>
    <MIN>sample string 3</MIN>
    <ReceivedDate>2024-11-26T17:38:18.2644737-05:00</ReceivedDate>
    <RequestingPartyOrg>sample string 6</RequestingPartyOrg>
    <RequestingPartyOrgId>sample string 5</RequestingPartyOrgId>
    <RespondedBy>sample string 16</RespondedBy>
    <RespondedDate>2024-11-26T17:38:18.2644737-05:00</RespondedDate>
    <SigningRoomId>1</SigningRoomId>
    <TrackingNumber>sample string 14</TrackingNumber>
    <TransferIdentifier>sample string 15</TransferIdentifier>
    <UserResponse>sample string 13</UserResponse>
  </NotificationModel>
</ArrayOfNotificationModel>