POST api/Reports/TransferableRecord/Download

Download a CSV file of transferable records retrieved using the search criteria.

Request Information

URI Parameters

None.

Body Parameters

The transferable record search criteria.

ESignSystems.SmartSAFE.Models.Reports.TransferableRecord.TransferableRecordSearchCriteria

Name	Description	Type	Additional information
ClientId	Gets or sets the client identifier.	integer	None.
DocumentName	Gets or sets the document name.	string	None.
DocumentTypeId	Gets or sets the document type identifier.	integer	None.
CreatedStartDate	Gets or sets the start created date.	date	Required
CreatedEndDate	Gets or sets the end created 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,
  "DocumentName": "sample string 1",
  "DocumentTypeId": 1,
  "CreatedStartDate": "2024-11-26T17:26:47.4239643-05:00",
  "CreatedEndDate": "2024-11-26T17:26:47.4239643-05:00",
  "PageSize": 1,
  "PageOffset": 2
}

application/xml, text/xml

Sample:

<TransferableRecordSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Reports.TransferableRecord">
  <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>
  <CreatedEndDate>2024-11-26T17:26:47.4239643-05:00</CreatedEndDate>
  <CreatedStartDate>2024-11-26T17:26:47.4239643-05:00</CreatedStartDate>
  <DocumentName>sample string 1</DocumentName>
  <DocumentTypeId>1</DocumentTypeId>
</TransferableRecordSearchCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A CSV file of transferable records.

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>