POST api/SmartTransfer/Search

Searches the SmartTRANSFER logs.

Request Information

URI Parameters

None.

Body Parameters

The search criteria.

ESignSystems.SmartSAFE.Models.SmartTransfer.SmartTransferSearchCriteria

Name	Description	Type	Additional information
ClientId	Gets or sets the client identifier.	integer	None.
StartDate	Gets or sets the start date.	date	Required
EndDate	Gets or sets the end date.	date	Required
SmartTransferPartnerId	Gets or sets the smart transfer partner identifier.	integer	None.
Status	Gets or sets the status (Success or Failure).	boolean	None.
Type	Gets or sets whether the transfer was incoming (or outgoing).	boolean	None.
DocumentName	Gets or sets the document name within the transfer.	string	None.
TransactionIdentifier	Gets or sets the transaction identifier.	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:

{
  "ClientId": 1,
  "StartDate": "2024-11-26T17:42:31.4881261-05:00",
  "EndDate": "2024-11-26T17:42:31.4881261-05:00",
  "SmartTransferPartnerId": 1,
  "Status": true,
  "Type": true,
  "DocumentName": "sample string 1",
  "TransactionIdentifier": "sample string 2",
  "PageSize": 1,
  "PageOffset": 3
}

application/xml, text/xml

Sample:

<SmartTransferSearchCriteria 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">3</PageOffset>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">1</PageSize>
  <ClientId>1</ClientId>
  <DocumentName>sample string 1</DocumentName>
  <EndDate>2024-11-26T17:42:31.4881261-05:00</EndDate>
  <SmartTransferPartnerId>1</SmartTransferPartnerId>
  <StartDate>2024-11-26T17:42:31.4881261-05:00</StartDate>
  <Status>true</Status>
  <TransactionIdentifier>sample string 2</TransactionIdentifier>
  <Type>true</Type>
</SmartTransferSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of results that match the given search criteria.

Collection of ESignSystems.SmartSAFE.Models.SmartTransfer.SmartTransferReportModel

Name	Description	Type	Additional information
SmartTransferLogId	Gets or sets the SmartTransfer Log identifier.	integer	None.
ClientId	Gets or sets the client identifier.	integer	None.
Date	Gets or sets the date.	date	None.
TransferPartnerId	Gets or sets the transfer partner identifier.	integer	None.
TransferPartnerName	Gets or sets the name of the transfer partner.	string	None.
AuthoritativeDocumentName	Gets or sets the name of the authoritative document.	string	None.
AuthoritativeDocument	Gets or sets the authoritative document.	ESignSystems.SmartSAFE.Models.SmartTransfer.SmartTransferReportDocumentModel	None.
AncillaryDocuments	Gets or sets the ancillary document names.	Collection of ESignSystems.SmartSAFE.Models.SmartTransfer.SmartTransferReportDocumentModel	None.
Type	Gets or sets a value indicating whether the transfer is incoming.	boolean	None.
Status	Gets or sets a value indicating whether the transfer succeeded or failed.	boolean	None.
Username	Gets or sets the username.	string	None.
TransactionIdentifier	Gets or sets the transaction identifier.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SmartTransferLogId": 1,
    "ClientId": 1,
    "Date": "2024-11-26T17:42:31.4881261-05:00",
    "TransferPartnerId": 1,
    "TransferPartnerName": "sample string 2",
    "AuthoritativeDocumentName": "sample string 3",
    "AuthoritativeDocument": {
      "DocumentId": 1,
      "SigningRoomId": 1,
      "DocumentName": "sample string 1"
    },
    "AncillaryDocuments": [
      {
        "DocumentId": 1,
        "SigningRoomId": 1,
        "DocumentName": "sample string 1"
      },
      {
        "DocumentId": 1,
        "SigningRoomId": 1,
        "DocumentName": "sample string 1"
      }
    ],
    "Type": true,
    "Status": true,
    "Username": "sample string 6",
    "TransactionIdentifier": "sample string 7"
  },
  {
    "SmartTransferLogId": 1,
    "ClientId": 1,
    "Date": "2024-11-26T17:42:31.4881261-05:00",
    "TransferPartnerId": 1,
    "TransferPartnerName": "sample string 2",
    "AuthoritativeDocumentName": "sample string 3",
    "AuthoritativeDocument": {
      "DocumentId": 1,
      "SigningRoomId": 1,
      "DocumentName": "sample string 1"
    },
    "AncillaryDocuments": [
      {
        "DocumentId": 1,
        "SigningRoomId": 1,
        "DocumentName": "sample string 1"
      },
      {
        "DocumentId": 1,
        "SigningRoomId": 1,
        "DocumentName": "sample string 1"
      }
    ],
    "Type": true,
    "Status": true,
    "Username": "sample string 6",
    "TransactionIdentifier": "sample string 7"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSmartTransferReportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <SmartTransferReportModel>
    <AncillaryDocuments>
      <SmartTransferReportDocumentModel>
        <DocumentId>1</DocumentId>
        <DocumentName>sample string 1</DocumentName>
        <SigningRoomId>1</SigningRoomId>
      </SmartTransferReportDocumentModel>
      <SmartTransferReportDocumentModel>
        <DocumentId>1</DocumentId>
        <DocumentName>sample string 1</DocumentName>
        <SigningRoomId>1</SigningRoomId>
      </SmartTransferReportDocumentModel>
    </AncillaryDocuments>
    <AuthoritativeDocument>
      <DocumentId>1</DocumentId>
      <DocumentName>sample string 1</DocumentName>
      <SigningRoomId>1</SigningRoomId>
    </AuthoritativeDocument>
    <AuthoritativeDocumentName>sample string 3</AuthoritativeDocumentName>
    <ClientId>1</ClientId>
    <Date>2024-11-26T17:42:31.4881261-05:00</Date>
    <SmartTransferLogId>1</SmartTransferLogId>
    <Status>true</Status>
    <TransactionIdentifier>sample string 7</TransactionIdentifier>
    <TransferPartnerId>1</TransferPartnerId>
    <TransferPartnerName>sample string 2</TransferPartnerName>
    <Type>true</Type>
    <Username>sample string 6</Username>
  </SmartTransferReportModel>
  <SmartTransferReportModel>
    <AncillaryDocuments>
      <SmartTransferReportDocumentModel>
        <DocumentId>1</DocumentId>
        <DocumentName>sample string 1</DocumentName>
        <SigningRoomId>1</SigningRoomId>
      </SmartTransferReportDocumentModel>
      <SmartTransferReportDocumentModel>
        <DocumentId>1</DocumentId>
        <DocumentName>sample string 1</DocumentName>
        <SigningRoomId>1</SigningRoomId>
      </SmartTransferReportDocumentModel>
    </AncillaryDocuments>
    <AuthoritativeDocument>
      <DocumentId>1</DocumentId>
      <DocumentName>sample string 1</DocumentName>
      <SigningRoomId>1</SigningRoomId>
    </AuthoritativeDocument>
    <AuthoritativeDocumentName>sample string 3</AuthoritativeDocumentName>
    <ClientId>1</ClientId>
    <Date>2024-11-26T17:42:31.4881261-05:00</Date>
    <SmartTransferLogId>1</SmartTransferLogId>
    <Status>true</Status>
    <TransactionIdentifier>sample string 7</TransactionIdentifier>
    <TransferPartnerId>1</TransferPartnerId>
    <TransferPartnerName>sample string 2</TransferPartnerName>
    <Type>true</Type>
    <Username>sample string 6</Username>
  </SmartTransferReportModel>
</ArrayOfSmartTransferReportModel>