POST api/SmartTransfer/AuthoritativeCopy/Download

Download a CSV file of authoritative copy search results retrieved using the search criteria.

Request Information

URI Parameters

None.

Body Parameters

The authoritative copy search criteria model.

ESignSystems.SmartSAFE.Models.SmartTransfer.AuthoritativeCopySearchCriteriaModel

Name	Description	Type	Additional information
ClientId	Gets or sets the client identifier to search through Authoritative Copy documents for.	integer	None.
DocumentName	Gets or sets document name.	string	Max length: 150
AuthoritativeCopy	Gets or sets authoritative copy.	boolean	None.
UDF1	Gets or sets udf1.	string	Max length: 256
UDF2	Gets or sets udf2.	string	Max length: 256
UDF3	Gets or sets udf3.	string	Max length: 256
SecuredParty	Gets or sets the secured party.	string	Max length: 256
PreviousSecuredParty	Gets or sets the previous secured party.	string	Max length: 256
DocumentAuditLogActionTypeId	Gets or sets the document audit log action type identifier.	integer	None.
DocumentTypeId	Gets or sets the document type identifier.	integer	None.
SecuredInterestStartDate	Gets or sets the secured interest start date.	date	None.
SecuredInterestEndDate	Gets or sets the secured interest end date.	date	None.
CreatedStartDate	Gets or sets the created start date.	date	None.
CreatedEndDate	Gets or sets the created end date.	date	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientId": 1,
  "DocumentName": "sample string 1",
  "AuthoritativeCopy": true,
  "UDF1": "sample string 2",
  "UDF2": "sample string 3",
  "UDF3": "sample string 4",
  "SecuredParty": "sample string 5",
  "PreviousSecuredParty": "sample string 6",
  "DocumentAuditLogActionTypeId": 1,
  "DocumentTypeId": 1,
  "SecuredInterestStartDate": "2024-11-26T17:41:02.3951369-05:00",
  "SecuredInterestEndDate": "2024-11-26T17:41:02.3951369-05:00",
  "CreatedStartDate": "2024-11-26T17:41:02.3951369-05:00",
  "CreatedEndDate": "2024-11-26T17:41:02.3951369-05:00"
}

application/xml, text/xml

Sample:

<AuthoritativeCopySearchCriteriaModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <AuthoritativeCopy>true</AuthoritativeCopy>
  <ClientId>1</ClientId>
  <CreatedEndDate>2024-11-26T17:41:02.3951369-05:00</CreatedEndDate>
  <CreatedStartDate>2024-11-26T17:41:02.3951369-05:00</CreatedStartDate>
  <DocumentAuditLogActionTypeId>1</DocumentAuditLogActionTypeId>
  <DocumentName>sample string 1</DocumentName>
  <DocumentTypeId>1</DocumentTypeId>
  <PreviousSecuredParty>sample string 6</PreviousSecuredParty>
  <SecuredInterestEndDate>2024-11-26T17:41:02.3951369-05:00</SecuredInterestEndDate>
  <SecuredInterestStartDate>2024-11-26T17:41:02.3951369-05:00</SecuredInterestStartDate>
  <SecuredParty>sample string 5</SecuredParty>
  <UDF1>sample string 2</UDF1>
  <UDF2>sample string 3</UDF2>
  <UDF3>sample string 4</UDF3>
</AuthoritativeCopySearchCriteriaModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A CSV file of authoritative copy search results.

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>