POST api/SmartTransfer/Transactions/Search

Searches the SmartTRANSFER transactions.

Request Information

URI Parameters

None.

Body Parameters

The search criteria.

ESignSystems.SmartSAFE.Models.SmartTransfer.SmartTransferTransactionSearchCriteria

Name	Description	Type	Additional information
ClientId	Gets or sets the client identifier.	integer	None.
OrganizationId	Gets or sets the organization identifier.	integer	None.
StartDate	Gets or sets the start date of the transaction.	date	Required
EndDate	Gets or sets the end date of the transaction.	date	Required
SmartTransferTransactionTypeId	Gets or sets the type of transaction.	integer	None.
DocumentName	Gets or sets the document name within the transfer.	string	Max length: 150
TransactionIdentifier	Gets or sets the transaction identifier.	string	Max length: 36
UDF1	Gets or sets the first user defined field.	string	Max length: 256
UDF2	Gets or sets the second user defined field.	string	Max length: 256
UDF3	Gets or sets the third user defined field.	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:

{
  "ClientId": 1,
  "OrganizationId": 1,
  "StartDate": "2024-11-26T17:23:52.8730334-05:00",
  "EndDate": "2024-11-26T17:23:52.8730334-05:00",
  "SmartTransferTransactionTypeId": 1,
  "DocumentName": "sample string 1",
  "TransactionIdentifier": "sample string 2",
  "UDF1": "sample string 3",
  "UDF2": "sample string 4",
  "UDF3": "sample string 5",
  "PageSize": 1,
  "PageOffset": 6
}

application/xml, text/xml

Sample:

<SmartTransferTransactionSearchCriteria 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">6</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:23:52.8730334-05:00</EndDate>
  <OrganizationId>1</OrganizationId>
  <SmartTransferTransactionTypeId>1</SmartTransferTransactionTypeId>
  <StartDate>2024-11-26T17:23:52.8730334-05:00</StartDate>
  <TransactionIdentifier>sample string 2</TransactionIdentifier>
  <UDF1>sample string 3</UDF1>
  <UDF2>sample string 4</UDF2>
  <UDF3>sample string 5</UDF3>
</SmartTransferTransactionSearchCriteria>

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

Name	Description	Type	Additional information
ClientId	Gets or sets the client identifier.	integer	None.
ClientName	Gets or sets the client name.	string	None.
DocumentId	Gets or sets the document identifier.	integer	None.
DocumentName	Gets or sets the document name.	string	None.
TransactionDate	Gets or sets the transaction date.	date	None.
SmartTransferTransactionType	Gets or sets the smart transfer transaction type.	string	None.
TransactionIdentifier	Gets or sets the transaction identifier.	string	None.
AuthoritativeCopy	Gets or sets a value indicating whether the transaction is for an authoritative copy.	boolean	None.
UDF1	Gets or sets the first user defined field.	string	None.
UDF2	Gets or sets the second user defined field.	string	None.
UDF3	Gets or sets the third user defined field.	string	None.
Error	Gets or sets a value indicating whether the transaction failed.	boolean	None.
ErrorMessage	Gets or sets the error message.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientId": 1,
    "ClientName": "sample string 1",
    "DocumentId": 1,
    "DocumentName": "sample string 2",
    "TransactionDate": "2024-11-26T17:23:52.8730334-05:00",
    "SmartTransferTransactionType": "sample string 3",
    "TransactionIdentifier": "sample string 4",
    "AuthoritativeCopy": true,
    "UDF1": "sample string 6",
    "UDF2": "sample string 7",
    "UDF3": "sample string 8",
    "Error": true,
    "ErrorMessage": "sample string 10"
  },
  {
    "ClientId": 1,
    "ClientName": "sample string 1",
    "DocumentId": 1,
    "DocumentName": "sample string 2",
    "TransactionDate": "2024-11-26T17:23:52.8730334-05:00",
    "SmartTransferTransactionType": "sample string 3",
    "TransactionIdentifier": "sample string 4",
    "AuthoritativeCopy": true,
    "UDF1": "sample string 6",
    "UDF2": "sample string 7",
    "UDF3": "sample string 8",
    "Error": true,
    "ErrorMessage": "sample string 10"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSmartTransferTransactionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <SmartTransferTransactionModel>
    <AuthoritativeCopy>true</AuthoritativeCopy>
    <ClientId>1</ClientId>
    <ClientName>sample string 1</ClientName>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 2</DocumentName>
    <Error>true</Error>
    <ErrorMessage>sample string 10</ErrorMessage>
    <SmartTransferTransactionType>sample string 3</SmartTransferTransactionType>
    <TransactionDate>2024-11-26T17:23:52.8730334-05:00</TransactionDate>
    <TransactionIdentifier>sample string 4</TransactionIdentifier>
    <UDF1>sample string 6</UDF1>
    <UDF2>sample string 7</UDF2>
    <UDF3>sample string 8</UDF3>
  </SmartTransferTransactionModel>
  <SmartTransferTransactionModel>
    <AuthoritativeCopy>true</AuthoritativeCopy>
    <ClientId>1</ClientId>
    <ClientName>sample string 1</ClientName>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 2</DocumentName>
    <Error>true</Error>
    <ErrorMessage>sample string 10</ErrorMessage>
    <SmartTransferTransactionType>sample string 3</SmartTransferTransactionType>
    <TransactionDate>2024-11-26T17:23:52.8730334-05:00</TransactionDate>
    <TransactionIdentifier>sample string 4</TransactionIdentifier>
    <UDF1>sample string 6</UDF1>
    <UDF2>sample string 7</UDF2>
    <UDF3>sample string 8</UDF3>
  </SmartTransferTransactionModel>
</ArrayOfSmartTransferTransactionModel>