POST api/SmartRegistry/Reports/NotificationLogs

Performs a notification log search based on the search criteria.

Request Information

URI Parameters

None.

Body Parameters

The search criteria.

ESignSystems.SmartSAFE.Models.SmartRegistry.NotificationLogSearchCriteria
NameDescriptionTypeAdditional information
RequestType

Gets or sets the RequestType to search by.

string

Max length: 256

Error

Gets or sets the Error to search by.

boolean

None.

StartRequestDate

Gets or sets the StartRequestDate to search by.

date

Required

EndRequestDate

Gets or sets the EndRequestDate to search by.

date

Required

NotificationData

Gets or sets the NotificationData to search by.

string

Max length: 256

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:
{
  "RequestType": "sample string 1",
  "Error": true,
  "StartRequestDate": "2024-11-26T17:40:41.5344183-05:00",
  "EndRequestDate": "2024-11-26T17:40:41.5344183-05:00",
  "NotificationData": "sample string 2",
  "PageSize": 1,
  "PageOffset": 3
}

application/xml, text/xml

Sample:
<NotificationLogSearchCriteria 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">3</PageOffset>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
  <EndRequestDate>2024-11-26T17:40:41.5344183-05:00</EndRequestDate>
  <Error>true</Error>
  <NotificationData>sample string 2</NotificationData>
  <RequestType>sample string 1</RequestType>
  <StartRequestDate>2024-11-26T17:40:41.5344183-05:00</StartRequestDate>
</NotificationLogSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of notification logs meeting the search criteria.

Collection of ESignSystems.SmartSAFE.Models.SmartRegistry.NotificationLogModel
NameDescriptionTypeAdditional information
ERegistryNotificationLogId

Gets or sets the eRegistry notification log id.

integer

Required

NotificationRequestType

Gets or sets the notification request type.

string

Max length: 256

NotificationData

Gets or sets the notification data.

string

None.

Processed

Gets or sets the processed status.

boolean

None.

Error

Gets or sets the error status.

boolean

None.

ErrorMessage

Gets or sets the error message.

string

Max length: 256

IPAddress

Gets or sets the IPAddress.

string

Max length: 256

ReceivedDate

Gets or sets the received date.

date

Required

Response Formats

application/json, text/json

Sample:
[
  {
    "ERegistryNotificationLogId": 1,
    "NotificationRequestType": "sample string 1",
    "NotificationData": "sample string 2",
    "Processed": true,
    "Error": true,
    "ErrorMessage": "sample string 5",
    "IPAddress": "sample string 6",
    "ReceivedDate": "2024-11-26T17:40:41.5344183-05:00"
  },
  {
    "ERegistryNotificationLogId": 1,
    "NotificationRequestType": "sample string 1",
    "NotificationData": "sample string 2",
    "Processed": true,
    "Error": true,
    "ErrorMessage": "sample string 5",
    "IPAddress": "sample string 6",
    "ReceivedDate": "2024-11-26T17:40:41.5344183-05:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfNotificationLogModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry">
  <NotificationLogModel>
    <ERegistryNotificationLogId>1</ERegistryNotificationLogId>
    <Error>true</Error>
    <ErrorMessage>sample string 5</ErrorMessage>
    <IPAddress>sample string 6</IPAddress>
    <NotificationData>sample string 2</NotificationData>
    <NotificationRequestType>sample string 1</NotificationRequestType>
    <Processed>true</Processed>
    <ReceivedDate>2024-11-26T17:40:41.5344183-05:00</ReceivedDate>
  </NotificationLogModel>
  <NotificationLogModel>
    <ERegistryNotificationLogId>1</ERegistryNotificationLogId>
    <Error>true</Error>
    <ErrorMessage>sample string 5</ErrorMessage>
    <IPAddress>sample string 6</IPAddress>
    <NotificationData>sample string 2</NotificationData>
    <NotificationRequestType>sample string 1</NotificationRequestType>
    <Processed>true</Processed>
    <ReceivedDate>2024-11-26T17:40:41.5344183-05:00</ReceivedDate>
  </NotificationLogModel>
</ArrayOfNotificationLogModel>