POST api/Reports/EventNotification
Allows a user to search for any event notifications that they have access to.
Request Information
URI Parameters
None.
Body Parameters
The event search criteria.
ESignSystems.SmartSAFE.Models.Reports.EventSearchCriteriaName | Description | Type | Additional information |
---|---|---|---|
OrganizationId |
Gets or sets the organization identifier. |
integer |
None. |
ClientId |
Gets or sets the client identifier. |
integer |
None. |
StartCreatedDate |
Gets or sets the start created date. |
date |
Required |
EndCreatedDate |
Gets or sets the end created date. |
date |
Required |
EventTypeId |
Gets or sets the event type identifier. |
integer |
None. |
NotificationDestination |
Gets or sets the notification destination. |
string |
None. |
SearchKey |
Gets or sets the search key. |
string |
None. |
SuccessStatusOnly |
Gets or sets a value indicating whether to only search for events that succeeded. |
boolean |
None. |
FailedStatusOnly |
Gets or sets a value indicating whether to only search for events that failed. |
boolean |
None. |
InProgressStatusOnly |
Gets or sets a value indicating whether to only search for events that are in progess. |
boolean |
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
{ "OrganizationId": 1, "ClientId": 1, "StartCreatedDate": "2024-11-26T17:20:32.3743146-05:00", "EndCreatedDate": "2024-11-26T17:20:32.3743146-05:00", "EventTypeId": 1, "NotificationDestination": "sample string 1", "SearchKey": "sample string 2", "SuccessStatusOnly": true, "FailedStatusOnly": true, "InProgressStatusOnly": true, "PageSize": 1, "PageOffset": 6 }
application/xml, text/xml
<EventSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Reports"> <PageOffset xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">6</PageOffset> <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize> <ClientId>1</ClientId> <EndCreatedDate>2024-11-26T17:20:32.3743146-05:00</EndCreatedDate> <EventTypeId>1</EventTypeId> <FailedStatusOnly>true</FailedStatusOnly> <InProgressStatusOnly>true</InProgressStatusOnly> <NotificationDestination>sample string 1</NotificationDestination> <OrganizationId>1</OrganizationId> <SearchKey>sample string 2</SearchKey> <StartCreatedDate>2024-11-26T17:20:32.3743146-05:00</StartCreatedDate> <SuccessStatusOnly>true</SuccessStatusOnly> </EventSearchCriteria>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The list of events resulting from the search.
Collection of ESignSystems.SmartSAFE.Data.Entities.EventNotification.EventName | Description | Type | Additional information |
---|---|---|---|
EventId | integer |
None. |
|
EventDate | date |
None. |
|
EventTypeId | integer |
None. |
|
EventType | ESignSystems.SmartSAFE.Data.Entities.EventNotification.EventType |
None. |
|
ClientId | integer |
None. |
|
CreatedBy | string |
Max length: 256 |
|
SearchKey | string |
Max length: 256 |
|
EventStatus | string |
Max length: 256 |
|
Notifications | Collection of ESignSystems.SmartSAFE.Data.Entities.EventNotification.EventNotification |
None. |
|
SerializedEventData | string |
None. |
Response Formats
application/json, text/json
[ { "EventId": 1, "EventDate": "2024-11-26T17:20:32.3743146-05:00", "EventTypeId": 1, "EventType": { "Id": 1, "EventTypeCategoryId": 1, "EventTypeCategory": { "Id": 1, "LookupValue": "sample string 1", "UpdatedDate": "2024-11-26T17:20:32.3899344-05:00", "UpdatedBy": "sample string 2" }, "DefaultEmailTemplate": "sample string 1", "DefaultEmailSubject": "sample string 2", "LookupValue": "sample string 3", "UpdatedDate": "2024-11-26T17:20:32.3899344-05:00", "UpdatedBy": "sample string 4" }, "ClientId": 1, "CreatedBy": "sample string 1", "SearchKey": "sample string 2", "EventStatus": "sample string 3", "Notifications": [ { "EventNotificationId": 1, "EventId": 1, "EventNotificationTypeId": 2, "EventNotificationType": { "EventNotificationTypeId": 1, "LookupValue": "sample string 2", "UpdatedDate": "2024-11-26T17:20:32.3899344-05:00", "UpdatedBy": "sample string 3" }, "Destination": "sample string 3", "EmailTemplate": "sample string 4", "EmailSubject": "sample string 5", "FromEmailAddress": "sample string 6", "FromEmailName": "sample string 7", "ReplyToEmailAddress": "sample string 8", "TargetInviteeObjectId": 1, "Complete": true, "CreatedDate": "2024-11-26T17:20:32.3899344-05:00", "ProcessedDate": "2024-11-26T17:20:32.3899344-05:00", "NumberOfAttempts": 10, "ErrorMessage": "sample string 11", "CCEmailAddress": "sample string 12", "LogEntries": [ { "EventNotificationLogId": 1, "EventNotificationId": 1, "Success": true, "ProcessedDate": "2024-11-26T17:20:32.3899344-05:00", "ErrorMessage": "sample string 2" }, { "EventNotificationLogId": 1, "EventNotificationId": 1, "Success": true, "ProcessedDate": "2024-11-26T17:20:32.3899344-05:00", "ErrorMessage": "sample string 2" } ] }, { "EventNotificationId": 1, "EventId": 1, "EventNotificationTypeId": 2, "EventNotificationType": { "EventNotificationTypeId": 1, "LookupValue": "sample string 2", "UpdatedDate": "2024-11-26T17:20:32.3899344-05:00", "UpdatedBy": "sample string 3" }, "Destination": "sample string 3", "EmailTemplate": "sample string 4", "EmailSubject": "sample string 5", "FromEmailAddress": "sample string 6", "FromEmailName": "sample string 7", "ReplyToEmailAddress": "sample string 8", "TargetInviteeObjectId": 1, "Complete": true, "CreatedDate": "2024-11-26T17:20:32.3899344-05:00", "ProcessedDate": "2024-11-26T17:20:32.3899344-05:00", "NumberOfAttempts": 10, "ErrorMessage": "sample string 11", "CCEmailAddress": "sample string 12", "LogEntries": [ { "EventNotificationLogId": 1, "EventNotificationId": 1, "Success": true, "ProcessedDate": "2024-11-26T17:20:32.3899344-05:00", "ErrorMessage": "sample string 2" }, { "EventNotificationLogId": 1, "EventNotificationId": 1, "Success": true, "ProcessedDate": "2024-11-26T17:20:32.3899344-05:00", "ErrorMessage": "sample string 2" } ] } ], "SerializedEventData": "sample string 4" }, { "EventId": 1, "EventDate": "2024-11-26T17:20:32.3743146-05:00", "EventTypeId": 1, "EventType": { "Id": 1, "EventTypeCategoryId": 1, "EventTypeCategory": { "Id": 1, "LookupValue": "sample string 1", "UpdatedDate": "2024-11-26T17:20:32.3899344-05:00", "UpdatedBy": "sample string 2" }, "DefaultEmailTemplate": "sample string 1", "DefaultEmailSubject": "sample string 2", "LookupValue": "sample string 3", "UpdatedDate": "2024-11-26T17:20:32.3899344-05:00", "UpdatedBy": "sample string 4" }, "ClientId": 1, "CreatedBy": "sample string 1", "SearchKey": "sample string 2", "EventStatus": "sample string 3", "Notifications": [ { "EventNotificationId": 1, "EventId": 1, "EventNotificationTypeId": 2, "EventNotificationType": { "EventNotificationTypeId": 1, "LookupValue": "sample string 2", "UpdatedDate": "2024-11-26T17:20:32.3899344-05:00", "UpdatedBy": "sample string 3" }, "Destination": "sample string 3", "EmailTemplate": "sample string 4", "EmailSubject": "sample string 5", "FromEmailAddress": "sample string 6", "FromEmailName": "sample string 7", "ReplyToEmailAddress": "sample string 8", "TargetInviteeObjectId": 1, "Complete": true, "CreatedDate": "2024-11-26T17:20:32.3899344-05:00", "ProcessedDate": "2024-11-26T17:20:32.3899344-05:00", "NumberOfAttempts": 10, "ErrorMessage": "sample string 11", "CCEmailAddress": "sample string 12", "LogEntries": [ { "EventNotificationLogId": 1, "EventNotificationId": 1, "Success": true, "ProcessedDate": "2024-11-26T17:20:32.3899344-05:00", "ErrorMessage": "sample string 2" }, { "EventNotificationLogId": 1, "EventNotificationId": 1, "Success": true, "ProcessedDate": "2024-11-26T17:20:32.3899344-05:00", "ErrorMessage": "sample string 2" } ] }, { "EventNotificationId": 1, "EventId": 1, "EventNotificationTypeId": 2, "EventNotificationType": { "EventNotificationTypeId": 1, "LookupValue": "sample string 2", "UpdatedDate": "2024-11-26T17:20:32.3899344-05:00", "UpdatedBy": "sample string 3" }, "Destination": "sample string 3", "EmailTemplate": "sample string 4", "EmailSubject": "sample string 5", "FromEmailAddress": "sample string 6", "FromEmailName": "sample string 7", "ReplyToEmailAddress": "sample string 8", "TargetInviteeObjectId": 1, "Complete": true, "CreatedDate": "2024-11-26T17:20:32.3899344-05:00", "ProcessedDate": "2024-11-26T17:20:32.3899344-05:00", "NumberOfAttempts": 10, "ErrorMessage": "sample string 11", "CCEmailAddress": "sample string 12", "LogEntries": [ { "EventNotificationLogId": 1, "EventNotificationId": 1, "Success": true, "ProcessedDate": "2024-11-26T17:20:32.3899344-05:00", "ErrorMessage": "sample string 2" }, { "EventNotificationLogId": 1, "EventNotificationId": 1, "Success": true, "ProcessedDate": "2024-11-26T17:20:32.3899344-05:00", "ErrorMessage": "sample string 2" } ] } ], "SerializedEventData": "sample string 4" } ]
application/xml, text/xml
<ArrayOfEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities.EventNotification"> <Event> <ClientId>1</ClientId> <CreatedBy>sample string 1</CreatedBy> <EventDate>2024-11-26T17:20:32.3743146-05:00</EventDate> <EventId>1</EventId> <EventStatus>sample string 3</EventStatus> <EventType> <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">sample string 4</UpdatedBy> <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">2024-11-26T17:20:32.3899344-05:00</UpdatedDate> <Id xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">1</Id> <LookupValue xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">sample string 3</LookupValue> <DefaultEmailSubject>sample string 2</DefaultEmailSubject> <DefaultEmailTemplate>sample string 1</DefaultEmailTemplate> <EventTypeCategory> <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">sample string 2</UpdatedBy> <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">2024-11-26T17:20:32.3899344-05:00</UpdatedDate> <Id xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">1</Id> <LookupValue xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">sample string 1</LookupValue> </EventTypeCategory> <EventTypeCategoryId>1</EventTypeCategoryId> </EventType> <EventTypeId>1</EventTypeId> <Notifications> <EventNotification> <CCEmailAddress>sample string 12</CCEmailAddress> <Complete>true</Complete> <CreatedDate>2024-11-26T17:20:32.3899344-05:00</CreatedDate> <Destination>sample string 3</Destination> <EmailSubject>sample string 5</EmailSubject> <EmailTemplate>sample string 4</EmailTemplate> <ErrorMessage>sample string 11</ErrorMessage> <EventId>1</EventId> <EventNotificationId>1</EventNotificationId> <EventNotificationType> <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">sample string 3</UpdatedBy> <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">2024-11-26T17:20:32.3899344-05:00</UpdatedDate> <EventNotificationTypeId>1</EventNotificationTypeId> <LookupValue>sample string 2</LookupValue> </EventNotificationType> <EventNotificationTypeId>2</EventNotificationTypeId> <FromEmailAddress>sample string 6</FromEmailAddress> <FromEmailName>sample string 7</FromEmailName> <LogEntries> <EventNotificationLog> <ErrorMessage>sample string 2</ErrorMessage> <EventNotificationId>1</EventNotificationId> <EventNotificationLogId>1</EventNotificationLogId> <ProcessedDate>2024-11-26T17:20:32.3899344-05:00</ProcessedDate> <Success>true</Success> </EventNotificationLog> <EventNotificationLog> <ErrorMessage>sample string 2</ErrorMessage> <EventNotificationId>1</EventNotificationId> <EventNotificationLogId>1</EventNotificationLogId> <ProcessedDate>2024-11-26T17:20:32.3899344-05:00</ProcessedDate> <Success>true</Success> </EventNotificationLog> </LogEntries> <NumberOfAttempts>10</NumberOfAttempts> <ProcessedDate>2024-11-26T17:20:32.3899344-05:00</ProcessedDate> <ReplyToEmailAddress>sample string 8</ReplyToEmailAddress> <TargetInviteeObjectId>1</TargetInviteeObjectId> </EventNotification> <EventNotification> <CCEmailAddress>sample string 12</CCEmailAddress> <Complete>true</Complete> <CreatedDate>2024-11-26T17:20:32.3899344-05:00</CreatedDate> <Destination>sample string 3</Destination> <EmailSubject>sample string 5</EmailSubject> <EmailTemplate>sample string 4</EmailTemplate> <ErrorMessage>sample string 11</ErrorMessage> <EventId>1</EventId> <EventNotificationId>1</EventNotificationId> <EventNotificationType> <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">sample string 3</UpdatedBy> <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">2024-11-26T17:20:32.3899344-05:00</UpdatedDate> <EventNotificationTypeId>1</EventNotificationTypeId> <LookupValue>sample string 2</LookupValue> </EventNotificationType> <EventNotificationTypeId>2</EventNotificationTypeId> <FromEmailAddress>sample string 6</FromEmailAddress> <FromEmailName>sample string 7</FromEmailName> <LogEntries> <EventNotificationLog> <ErrorMessage>sample string 2</ErrorMessage> <EventNotificationId>1</EventNotificationId> <EventNotificationLogId>1</EventNotificationLogId> <ProcessedDate>2024-11-26T17:20:32.3899344-05:00</ProcessedDate> <Success>true</Success> </EventNotificationLog> <EventNotificationLog> <ErrorMessage>sample string 2</ErrorMessage> <EventNotificationId>1</EventNotificationId> <EventNotificationLogId>1</EventNotificationLogId> <ProcessedDate>2024-11-26T17:20:32.3899344-05:00</ProcessedDate> <Success>true</Success> </EventNotificationLog> </LogEntries> <NumberOfAttempts>10</NumberOfAttempts> <ProcessedDate>2024-11-26T17:20:32.3899344-05:00</ProcessedDate> <ReplyToEmailAddress>sample string 8</ReplyToEmailAddress> <TargetInviteeObjectId>1</TargetInviteeObjectId> </EventNotification> </Notifications> <SearchKey>sample string 2</SearchKey> <SerializedEventData>sample string 4</SerializedEventData> </Event> <Event> <ClientId>1</ClientId> <CreatedBy>sample string 1</CreatedBy> <EventDate>2024-11-26T17:20:32.3743146-05:00</EventDate> <EventId>1</EventId> <EventStatus>sample string 3</EventStatus> <EventType> <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">sample string 4</UpdatedBy> <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">2024-11-26T17:20:32.3899344-05:00</UpdatedDate> <Id xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">1</Id> <LookupValue xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">sample string 3</LookupValue> <DefaultEmailSubject>sample string 2</DefaultEmailSubject> <DefaultEmailTemplate>sample string 1</DefaultEmailTemplate> <EventTypeCategory> <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">sample string 2</UpdatedBy> <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">2024-11-26T17:20:32.3899344-05:00</UpdatedDate> <Id xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">1</Id> <LookupValue xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">sample string 1</LookupValue> </EventTypeCategory> <EventTypeCategoryId>1</EventTypeCategoryId> </EventType> <EventTypeId>1</EventTypeId> <Notifications> <EventNotification> <CCEmailAddress>sample string 12</CCEmailAddress> <Complete>true</Complete> <CreatedDate>2024-11-26T17:20:32.3899344-05:00</CreatedDate> <Destination>sample string 3</Destination> <EmailSubject>sample string 5</EmailSubject> <EmailTemplate>sample string 4</EmailTemplate> <ErrorMessage>sample string 11</ErrorMessage> <EventId>1</EventId> <EventNotificationId>1</EventNotificationId> <EventNotificationType> <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">sample string 3</UpdatedBy> <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">2024-11-26T17:20:32.3899344-05:00</UpdatedDate> <EventNotificationTypeId>1</EventNotificationTypeId> <LookupValue>sample string 2</LookupValue> </EventNotificationType> <EventNotificationTypeId>2</EventNotificationTypeId> <FromEmailAddress>sample string 6</FromEmailAddress> <FromEmailName>sample string 7</FromEmailName> <LogEntries> <EventNotificationLog> <ErrorMessage>sample string 2</ErrorMessage> <EventNotificationId>1</EventNotificationId> <EventNotificationLogId>1</EventNotificationLogId> <ProcessedDate>2024-11-26T17:20:32.3899344-05:00</ProcessedDate> <Success>true</Success> </EventNotificationLog> <EventNotificationLog> <ErrorMessage>sample string 2</ErrorMessage> <EventNotificationId>1</EventNotificationId> <EventNotificationLogId>1</EventNotificationLogId> <ProcessedDate>2024-11-26T17:20:32.3899344-05:00</ProcessedDate> <Success>true</Success> </EventNotificationLog> </LogEntries> <NumberOfAttempts>10</NumberOfAttempts> <ProcessedDate>2024-11-26T17:20:32.3899344-05:00</ProcessedDate> <ReplyToEmailAddress>sample string 8</ReplyToEmailAddress> <TargetInviteeObjectId>1</TargetInviteeObjectId> </EventNotification> <EventNotification> <CCEmailAddress>sample string 12</CCEmailAddress> <Complete>true</Complete> <CreatedDate>2024-11-26T17:20:32.3899344-05:00</CreatedDate> <Destination>sample string 3</Destination> <EmailSubject>sample string 5</EmailSubject> <EmailTemplate>sample string 4</EmailTemplate> <ErrorMessage>sample string 11</ErrorMessage> <EventId>1</EventId> <EventNotificationId>1</EventNotificationId> <EventNotificationType> <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">sample string 3</UpdatedBy> <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Data.Entities">2024-11-26T17:20:32.3899344-05:00</UpdatedDate> <EventNotificationTypeId>1</EventNotificationTypeId> <LookupValue>sample string 2</LookupValue> </EventNotificationType> <EventNotificationTypeId>2</EventNotificationTypeId> <FromEmailAddress>sample string 6</FromEmailAddress> <FromEmailName>sample string 7</FromEmailName> <LogEntries> <EventNotificationLog> <ErrorMessage>sample string 2</ErrorMessage> <EventNotificationId>1</EventNotificationId> <EventNotificationLogId>1</EventNotificationLogId> <ProcessedDate>2024-11-26T17:20:32.3899344-05:00</ProcessedDate> <Success>true</Success> </EventNotificationLog> <EventNotificationLog> <ErrorMessage>sample string 2</ErrorMessage> <EventNotificationId>1</EventNotificationId> <EventNotificationLogId>1</EventNotificationLogId> <ProcessedDate>2024-11-26T17:20:32.3899344-05:00</ProcessedDate> <Success>true</Success> </EventNotificationLog> </LogEntries> <NumberOfAttempts>10</NumberOfAttempts> <ProcessedDate>2024-11-26T17:20:32.3899344-05:00</ProcessedDate> <ReplyToEmailAddress>sample string 8</ReplyToEmailAddress> <TargetInviteeObjectId>1</TargetInviteeObjectId> </EventNotification> </Notifications> <SearchKey>sample string 2</SearchKey> <SerializedEventData>sample string 4</SerializedEventData> </Event> </ArrayOfEvent>