POST api/SmartTransfer/ExternalEVaultNotificationLog/Search

Provides the ability to search the external eVault notification log.

Request Information

URI Parameters

None.

Body Parameters

The external eVault notification log search criteria.

ESignSystems.SmartSAFE.Models.SmartTransfer.ExternalEVaultNotificationLogSearchCriteria

Name	Description	Type	Additional information
ClientId	Gets or sets the client identifier.	integer	None.
OrganizationId	Gets or sets the organization identifier.	integer	None.
MessageIdentifier	Gets or sets the message identifier.	string	Max length: 256
Error	Gets or sets whether to include transfers that had an error.	boolean	None.
StartReceivedDate	Gets or sets the start received date.	date	Required
EndReceivedDate	Gets or sets the end received date.	date	Required
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:

{
  "ClientId": 1,
  "OrganizationId": 1,
  "MessageIdentifier": "sample string 1",
  "Error": true,
  "StartReceivedDate": "2024-11-26T17:39:20.5184094-05:00",
  "EndReceivedDate": "2024-11-26T17:39:20.5184094-05:00",
  "PageSize": 1,
  "PageOffset": 2
}

application/xml, text/xml

Sample:

<ExternalEVaultNotificationLogSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <PageOffset xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2</PageOffset>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
  <ClientId>1</ClientId>
  <EndReceivedDate>2024-11-26T17:39:20.5184094-05:00</EndReceivedDate>
  <Error>true</Error>
  <MessageIdentifier>sample string 1</MessageIdentifier>
  <OrganizationId>1</OrganizationId>
  <StartReceivedDate>2024-11-26T17:39:20.5184094-05:00</StartReceivedDate>
</ExternalEVaultNotificationLogSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of .

Collection of ESignSystems.SmartSAFE.Models.SmartTransfer.ExternalEVaultNotificationLogModel

Name	Description	Type	Additional information
ExternalEVaultNotificationLogId	Gets or sets the external eVault notification identifier.	integer	None.
ClientId	Gets or sets the client identifier.	integer	None.
ClientName	Gets or sets the client name.	string	None.
OrganizationName	Gets or sets the organization name.	string	None.
ExternalEVaultName	Gets or sets the external eVault name.	string	Required Max length: 256
MessageId	Gets or sets the message identifier.	string	Max length: 256
Message	Gets or sets the message.	string	None.
Processed	Gets or sets a value indicating whether this notification has been processed and the document transferred.	boolean	None.
Error	Gets or sets a value indicating whether there was an error with the final transfer process.	boolean	None.
ErrorMessage	Gets or sets the error message.	string	Max length: 256
ReceivedDate	Gets or sets the received date.	date	Required
UpdatedBy	Gets or sets the name of the user that updated the model.	string	None.
UpdatedDate	Gets or sets the date an time that the model was updated.	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ExternalEVaultNotificationLogId": 1,
    "ClientId": 1,
    "ClientName": "sample string 1",
    "OrganizationName": "sample string 2",
    "ExternalEVaultName": "sample string 3",
    "MessageId": "sample string 4",
    "Message": "sample string 5",
    "Processed": true,
    "Error": true,
    "ErrorMessage": "sample string 8",
    "ReceivedDate": "2024-11-26T17:39:20.5340211-05:00",
    "UpdatedBy": "sample string 9",
    "UpdatedDate": "2024-11-26T17:39:20.5340211-05:00"
  },
  {
    "ExternalEVaultNotificationLogId": 1,
    "ClientId": 1,
    "ClientName": "sample string 1",
    "OrganizationName": "sample string 2",
    "ExternalEVaultName": "sample string 3",
    "MessageId": "sample string 4",
    "Message": "sample string 5",
    "Processed": true,
    "Error": true,
    "ErrorMessage": "sample string 8",
    "ReceivedDate": "2024-11-26T17:39:20.5340211-05:00",
    "UpdatedBy": "sample string 9",
    "UpdatedDate": "2024-11-26T17:39:20.5340211-05:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfExternalEVaultNotificationLogModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <ExternalEVaultNotificationLogModel>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 9</UpdatedBy>
    <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:39:20.5340211-05:00</UpdatedDate>
    <ClientId>1</ClientId>
    <ClientName>sample string 1</ClientName>
    <Error>true</Error>
    <ErrorMessage>sample string 8</ErrorMessage>
    <ExternalEVaultName>sample string 3</ExternalEVaultName>
    <ExternalEVaultNotificationLogId>1</ExternalEVaultNotificationLogId>
    <Message>sample string 5</Message>
    <MessageId>sample string 4</MessageId>
    <OrganizationName>sample string 2</OrganizationName>
    <Processed>true</Processed>
    <ReceivedDate>2024-11-26T17:39:20.5340211-05:00</ReceivedDate>
  </ExternalEVaultNotificationLogModel>
  <ExternalEVaultNotificationLogModel>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 9</UpdatedBy>
    <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:39:20.5340211-05:00</UpdatedDate>
    <ClientId>1</ClientId>
    <ClientName>sample string 1</ClientName>
    <Error>true</Error>
    <ErrorMessage>sample string 8</ErrorMessage>
    <ExternalEVaultName>sample string 3</ExternalEVaultName>
    <ExternalEVaultNotificationLogId>1</ExternalEVaultNotificationLogId>
    <Message>sample string 5</Message>
    <MessageId>sample string 4</MessageId>
    <OrganizationName>sample string 2</OrganizationName>
    <Processed>true</Processed>
    <ReceivedDate>2024-11-26T17:39:20.5340211-05:00</ReceivedDate>
  </ExternalEVaultNotificationLogModel>
</ArrayOfExternalEVaultNotificationLogModel>