GET api/Documents/{documentId}/SecuredInterest
Gets the secured interest for the provided document identifier.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| documentId |
The document identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The document secured interest model.
ESignSystems.SmartSAFE.Models.Documents.DocumentSecuredInterestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentId |
Gets or sets the document identifier this secured interest information pertains to. |
integer |
None. |
| SecuredInterestDate |
Gets or sets the date the document started being an Authoritative Copy. |
date |
None. |
| SecuredInterestActionType |
Gets or sets the lookup value of the action type that caused the document to become an authoritative copy. |
string |
None. |
| SecuredInterestActionSetsAuthoritativeCopyTo |
Gets or sets a flag that represents the side effect this actions would have had on a document's AuthoritativeCopy flag. |
boolean |
None. |
| SecuredParty |
Gets or sets the current Secured Party for this document. |
string |
None. |
| PreviousSecuredParty |
Gets or sets the Previous Secured Party for this document. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"DocumentId": 1,
"SecuredInterestDate": "2024-11-26T17:30:13.5579531-05:00",
"SecuredInterestActionType": "sample string 1",
"SecuredInterestActionSetsAuthoritativeCopyTo": true,
"SecuredParty": "sample string 2",
"PreviousSecuredParty": "sample string 3"
}
application/xml, text/xml
Sample:
<DocumentSecuredInterestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Documents"> <DocumentId>1</DocumentId> <PreviousSecuredParty>sample string 3</PreviousSecuredParty> <SecuredInterestActionSetsAuthoritativeCopyTo>true</SecuredInterestActionSetsAuthoritativeCopyTo> <SecuredInterestActionType>sample string 1</SecuredInterestActionType> <SecuredInterestDate>2024-11-26T17:30:13.5579531-05:00</SecuredInterestDate> <SecuredParty>sample string 2</SecuredParty> </DocumentSecuredInterestModel>