POST api/SmartTransfer/Download

Download a CSV file of SmartTRANSFER logs retrieved using the search criteria.

Request Information

URI Parameters

None.

Body Parameters

The smart transfer search criteria model.

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": "2025-05-02T03:22:56.7825613-07:00",
  "EndDate": "2025-05-02T03:22:56.7825613-07: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>2025-05-02T03:22:56.7825613-07:00</EndDate>
  <SmartTransferPartnerId>1</SmartTransferPartnerId>
  <StartDate>2025-05-02T03:22:56.7825613-07: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

A CSV file of SmartTRANSFER logs.

Collection of 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"
  },
  {
    "File": "QEA=",
    "FileName": "sample string 1",
    "MimeType": "sample string 2"
  }
]

application/xml, text/xml

Sample:

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