POST api/SmartTransfer/Transactions/Download

Download a CSV file of SmartTRANSFER transactions based on the search criteria.

Request Information

URI Parameters

None.

Body Parameters

The smart transfer transaction search criteria model.

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
AuthoritativeCopy	Gets or sets authoritative copy.	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

Sample:

{
  "ClientId": 1,
  "OrganizationId": 1,
  "StartDate": "2025-05-02T03:17:22.0125737-07:00",
  "EndDate": "2025-05-02T03:17:22.0125737-07:00",
  "SmartTransferTransactionTypeId": 1,
  "DocumentName": "sample string 1",
  "TransactionIdentifier": "sample string 2",
  "UDF1": "sample string 3",
  "UDF2": "sample string 4",
  "UDF3": "sample string 5",
  "AuthoritativeCopy": true,
  "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>
  <AuthoritativeCopy>true</AuthoritativeCopy>
  <ClientId>1</ClientId>
  <DocumentName>sample string 1</DocumentName>
  <EndDate>2025-05-02T03:17:22.0125737-07:00</EndDate>
  <OrganizationId>1</OrganizationId>
  <SmartTransferTransactionTypeId>1</SmartTransferTransactionTypeId>
  <StartDate>2025-05-02T03:17:22.0125737-07: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

The CSV file of SmartTRANSFER transactions.

ESignSystems.SmartSAFE.Models.Shared.FileDownloadModel

Name	Description	Type	Additional information
File	Gets or sets the file to be downloaded.	Collection of byte	None.
FileName	Gets or sets the name of the file to be downloaded.	string	None.
MimeType	Gets or sets the mime type of the file to be downloaded.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "File": "QEA=",
  "FileName": "sample string 1",
  "MimeType": "sample string 2"
}

application/xml, text/xml

Sample:

<FileDownloadModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Shared">
  <File>QEA=</File>
  <FileName>sample string 1</FileName>
  <MimeType>sample string 2</MimeType>
</FileDownloadModel>