POST api/Reports/TransferableRecord/Search

Allows a user to search for transferable records.

Request Information

URI Parameters

None.

Body Parameters

The search criteria to filter the result by.

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:13:29.3536325-05:00",
  "CreatedEndDate": "2024-11-26T17:13:29.3536325-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:13:29.3536325-05:00</CreatedEndDate>
  <CreatedStartDate>2024-11-26T17:13:29.3536325-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 list of records where each record represents a transferable document.

Collection of ESignSystems.SmartSAFE.Models.Reports.TransferableRecord.TransferableRecordModel

Name	Description	Type	Additional information
DocumentName	Gets or sets the name for the document this record is representing.	string	None.
DocumentId	Gets or sets the identifier for the document this record is representing.	integer	None.
CreatedDate	Gets or sets the created date for the document this record is representing.	date	None.
TransferableRecord	Gets or sets whether the document this record is respresenting is tranferable.	boolean	None.
AuthoritativeCopy	Gets or sets whether the document this record is representing is an authoritative copy.	boolean	None.
UDF1	Gets or sets the UDF1 field for the document this record is representing.	string	None.
UDF2	Gets or sets the UDF2 field for the document this record is representing.	string	None.
UDF3	Gets or sets the UDF3 field for the document this record is representing.	string	None.
DocumentType	Gets or sets the document type for the document this record is representing.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DocumentName": "sample string 1",
    "DocumentId": 1,
    "CreatedDate": "2024-11-26T17:13:29.3692528-05:00",
    "TransferableRecord": true,
    "AuthoritativeCopy": true,
    "UDF1": "sample string 4",
    "UDF2": "sample string 5",
    "UDF3": "sample string 6",
    "DocumentType": "sample string 7"
  },
  {
    "DocumentName": "sample string 1",
    "DocumentId": 1,
    "CreatedDate": "2024-11-26T17:13:29.3692528-05:00",
    "TransferableRecord": true,
    "AuthoritativeCopy": true,
    "UDF1": "sample string 4",
    "UDF2": "sample string 5",
    "UDF3": "sample string 6",
    "DocumentType": "sample string 7"
  }
]

application/xml, text/xml

Sample:

<ArrayOfTransferableRecordModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Reports.TransferableRecord">
  <TransferableRecordModel>
    <AuthoritativeCopy>true</AuthoritativeCopy>
    <CreatedDate>2024-11-26T17:13:29.3692528-05:00</CreatedDate>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 1</DocumentName>
    <DocumentType>sample string 7</DocumentType>
    <TransferableRecord>true</TransferableRecord>
    <UDF1>sample string 4</UDF1>
    <UDF2>sample string 5</UDF2>
    <UDF3>sample string 6</UDF3>
  </TransferableRecordModel>
  <TransferableRecordModel>
    <AuthoritativeCopy>true</AuthoritativeCopy>
    <CreatedDate>2024-11-26T17:13:29.3692528-05:00</CreatedDate>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 1</DocumentName>
    <DocumentType>sample string 7</DocumentType>
    <TransferableRecord>true</TransferableRecord>
    <UDF1>sample string 4</UDF1>
    <UDF2>sample string 5</UDF2>
    <UDF3>sample string 6</UDF3>
  </TransferableRecordModel>
</ArrayOfTransferableRecordModel>