POST api/Documents/Linked/Children

Gets the linked child documents for the provided document identifiers.

Request Information

URI Parameters

None.

Body Parameters

The document identifiers.

Collection of integer

Request Formats

application/json, text/json

Sample:

[
  1,
  2
]

application/xml, text/xml

Sample:

<ArrayOflong xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <long>1</long>
  <long>2</long>
</ArrayOflong>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The linked documents models.

ESignSystems.SmartSAFE.Models.Documents.LinkedDocumentsModel

Name	Description	Type	Additional information
DocumentId	Gets or sets the document identifier.	integer	None.
ParentDocument	The parent document.	ESignSystems.SmartSAFE.Models.Documents.LinkedDocumentModel	None.
ChildDocuments	The child documents.	Collection of ESignSystems.SmartSAFE.Models.Documents.LinkedDocumentModel	None.

Response Formats

application/json, text/json

Sample:

{
  "DocumentId": 1,
  "ParentDocument": {
    "DocumentId": 1,
    "DocumentName": "sample string 1",
    "IsPDF": true,
    "IsSmartDoc": true,
    "AuthoritativeCopy": true,
    "LinkedBy": "sample string 5",
    "LinkedDate": "2024-11-26T17:39:01.7639015-05:00"
  },
  "ChildDocuments": [
    {
      "DocumentId": 1,
      "DocumentName": "sample string 1",
      "IsPDF": true,
      "IsSmartDoc": true,
      "AuthoritativeCopy": true,
      "LinkedBy": "sample string 5",
      "LinkedDate": "2024-11-26T17:39:01.7639015-05:00"
    },
    {
      "DocumentId": 1,
      "DocumentName": "sample string 1",
      "IsPDF": true,
      "IsSmartDoc": true,
      "AuthoritativeCopy": true,
      "LinkedBy": "sample string 5",
      "LinkedDate": "2024-11-26T17:39:01.7639015-05:00"
    }
  ]
}

application/xml, text/xml

Sample:

<LinkedDocumentsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Documents">
  <ChildDocuments>
    <LinkedDocumentModel>
      <AuthoritativeCopy>true</AuthoritativeCopy>
      <DocumentId>1</DocumentId>
      <DocumentName>sample string 1</DocumentName>
      <IsPDF>true</IsPDF>
      <IsSmartDoc>true</IsSmartDoc>
      <LinkedBy>sample string 5</LinkedBy>
      <LinkedDate>2024-11-26T17:39:01.7639015-05:00</LinkedDate>
    </LinkedDocumentModel>
    <LinkedDocumentModel>
      <AuthoritativeCopy>true</AuthoritativeCopy>
      <DocumentId>1</DocumentId>
      <DocumentName>sample string 1</DocumentName>
      <IsPDF>true</IsPDF>
      <IsSmartDoc>true</IsSmartDoc>
      <LinkedBy>sample string 5</LinkedBy>
      <LinkedDate>2024-11-26T17:39:01.7639015-05:00</LinkedDate>
    </LinkedDocumentModel>
  </ChildDocuments>
  <DocumentId>1</DocumentId>
  <ParentDocument>
    <AuthoritativeCopy>true</AuthoritativeCopy>
    <DocumentId>1</DocumentId>
    <DocumentName>sample string 1</DocumentName>
    <IsPDF>true</IsPDF>
    <IsSmartDoc>true</IsSmartDoc>
    <LinkedBy>sample string 5</LinkedBy>
    <LinkedDate>2024-11-26T17:39:01.7639015-05:00</LinkedDate>
  </ParentDocument>
</LinkedDocumentsModel>