POST api/SmartTransfer/AuthoritativeCopy/Search

Provides the ability to search for Authoritative Copy documents.

Request Information

URI Parameters

None.

Body Parameters

The model that represent the criteria to search with.

ESignSystems.SmartSAFE.Models.SmartTransfer.AuthoritativeCopySearchCriteriaModel
NameDescriptionTypeAdditional 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:23:01.5797516-05:00",
  "SecuredInterestEndDate": "2024-11-26T17:23:01.5797516-05:00",
  "CreatedStartDate": "2024-11-26T17:23:01.5797516-05:00",
  "CreatedEndDate": "2024-11-26T17:23:01.5797516-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:23:01.5797516-05:00</CreatedEndDate>
  <CreatedStartDate>2024-11-26T17:23:01.5797516-05:00</CreatedStartDate>
  <DocumentAuditLogActionTypeId>1</DocumentAuditLogActionTypeId>
  <DocumentName>sample string 1</DocumentName>
  <DocumentTypeId>1</DocumentTypeId>
  <PreviousSecuredParty>sample string 6</PreviousSecuredParty>
  <SecuredInterestEndDate>2024-11-26T17:23:01.5797516-05:00</SecuredInterestEndDate>
  <SecuredInterestStartDate>2024-11-26T17:23:01.5797516-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

List of models that match the given search criteria.

Collection of ESignSystems.SmartSAFE.Models.SmartTransfer.AuthoritativeCopySearchResultModel
NameDescriptionTypeAdditional information
DocumentId

Gets or sets the document identifier.

 integer

None.
DocumentName

Gets or sets the document name.

 string

None.
AuthoritativeCopy

Gets or sets the Authoritative Copy value.

 boolean

None.
UDF1

Gets or sets the UDF1 value.

 string

None.
UDF2

Gets or sets the UDF2 value.

 string

None.
UDF3

Gets or sets the UDF3 value.

 string

None.
DocumentType

Gets or sets the lookup value of the document type.

 string

None.
SecuredInterestDate

Gets or sets the secured interest date.

 date

None.
SecuredInterestReleaseDate

Gets or sets the secured interest release date.

 date

None.
SecuredParty

Gets or sets the secured party.

 string

None.
PreviousSecuredParty

Gets or sets the previous secured party.

 string

None.
SecuredInterestActionType

Gets or sets the lookup value of the secured interest action type.

 string

None.
CreatedDate

Gets or sets the created date.

 date

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "DocumentId": 1,
    "DocumentName": "sample string 1",
    "AuthoritativeCopy": true,
    "UDF1": "sample string 3",
    "UDF2": "sample string 4",
    "UDF3": "sample string 5",
    "DocumentType": "sample string 6",
    "SecuredInterestDate": "2024-11-26T17:23:01.5797516-05:00",
    "SecuredInterestReleaseDate": "2024-11-26T17:23:01.5797516-05:00",
    "SecuredParty": "sample string 7",
    "PreviousSecuredParty": "sample string 8",
    "SecuredInterestActionType": "sample string 9",
    "CreatedDate": "2024-11-26T17:23:01.5797516-05:00"
  },
  {
    "DocumentId": 1,
    "DocumentName": "sample string 1",
    "AuthoritativeCopy": true,
    "UDF1": "sample string 3",
    "UDF2": "sample string 4",
    "UDF3": "sample string 5",
    "DocumentType": "sample string 6",
    "SecuredInterestDate": "2024-11-26T17:23:01.5797516-05:00",
    "SecuredInterestReleaseDate": "2024-11-26T17:23:01.5797516-05:00",
    "SecuredParty": "sample string 7",
    "PreviousSecuredParty": "sample string 8",
    "SecuredInterestActionType": "sample string 9",
    "CreatedDate": "2024-11-26T17:23:01.5797516-05:00"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfAuthoritativeCopySearchResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartTransfer">
  <AuthoritativeCopySearchResultModel>
    <AuthoritativeCopy>true</AuthoritativeCopy>
    <CreatedDate>2024-11-26T17:23:01.5797516-05:00</CreatedDate>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 1</DocumentName>
    <DocumentType>sample string 6</DocumentType>
    <PreviousSecuredParty>sample string 8</PreviousSecuredParty>
    <SecuredInterestActionType>sample string 9</SecuredInterestActionType>
    <SecuredInterestDate>2024-11-26T17:23:01.5797516-05:00</SecuredInterestDate>
    <SecuredInterestReleaseDate>2024-11-26T17:23:01.5797516-05:00</SecuredInterestReleaseDate>
    <SecuredParty>sample string 7</SecuredParty>
    <UDF1>sample string 3</UDF1>
    <UDF2>sample string 4</UDF2>
    <UDF3>sample string 5</UDF3>
  </AuthoritativeCopySearchResultModel>
  <AuthoritativeCopySearchResultModel>
    <AuthoritativeCopy>true</AuthoritativeCopy>
    <CreatedDate>2024-11-26T17:23:01.5797516-05:00</CreatedDate>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 1</DocumentName>
    <DocumentType>sample string 6</DocumentType>
    <PreviousSecuredParty>sample string 8</PreviousSecuredParty>
    <SecuredInterestActionType>sample string 9</SecuredInterestActionType>
    <SecuredInterestDate>2024-11-26T17:23:01.5797516-05:00</SecuredInterestDate>
    <SecuredInterestReleaseDate>2024-11-26T17:23:01.5797516-05:00</SecuredInterestReleaseDate>
    <SecuredParty>sample string 7</SecuredParty>
    <UDF1>sample string 3</UDF1>
    <UDF2>sample string 4</UDF2>
    <UDF3>sample string 5</UDF3>
  </AuthoritativeCopySearchResultModel>
</ArrayOfAuthoritativeCopySearchResultModel>