POST api/Documents/Linked

Links multiple documents to a parent document.

Request Information

URI Parameters

None.

Body Parameters

The list of add linked documents model.

ESignSystems.SmartSAFE.Models.Documents.AddLinkedDocumentsModel

Name	Description	Type	Additional information
LinkedDocumentIds	Gets or sets a list of linked document identifiers.	Collection of integer	None.
DocumentId	Gets or sets the document identifier.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "LinkedDocumentIds": [
    1,
    2
  ],
  "DocumentId": 1
}

application/xml, text/xml

Sample:

<AddLinkedDocumentsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Documents">
  <DocumentId>1</DocumentId>
  <LinkedDocumentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </LinkedDocumentIds>
</AddLinkedDocumentsModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of linked documents model.

Collection of 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:34:30.2758827-05:00"
    },
    "ChildDocuments": [
      {
        "DocumentId": 1,
        "DocumentName": "sample string 1",
        "IsPDF": true,
        "IsSmartDoc": true,
        "AuthoritativeCopy": true,
        "LinkedBy": "sample string 5",
        "LinkedDate": "2024-11-26T17:34:30.2758827-05:00"
      },
      {
        "DocumentId": 1,
        "DocumentName": "sample string 1",
        "IsPDF": true,
        "IsSmartDoc": true,
        "AuthoritativeCopy": true,
        "LinkedBy": "sample string 5",
        "LinkedDate": "2024-11-26T17:34:30.2758827-05:00"
      }
    ]
  },
  {
    "DocumentId": 1,
    "ParentDocument": {
      "DocumentId": 1,
      "DocumentName": "sample string 1",
      "IsPDF": true,
      "IsSmartDoc": true,
      "AuthoritativeCopy": true,
      "LinkedBy": "sample string 5",
      "LinkedDate": "2024-11-26T17:34:30.2758827-05:00"
    },
    "ChildDocuments": [
      {
        "DocumentId": 1,
        "DocumentName": "sample string 1",
        "IsPDF": true,
        "IsSmartDoc": true,
        "AuthoritativeCopy": true,
        "LinkedBy": "sample string 5",
        "LinkedDate": "2024-11-26T17:34:30.2758827-05:00"
      },
      {
        "DocumentId": 1,
        "DocumentName": "sample string 1",
        "IsPDF": true,
        "IsSmartDoc": true,
        "AuthoritativeCopy": true,
        "LinkedBy": "sample string 5",
        "LinkedDate": "2024-11-26T17:34:30.2758827-05:00"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfLinkedDocumentsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Documents">
  <LinkedDocumentsModel>
    <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:34:30.2758827-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:34:30.2758827-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:34:30.2758827-05:00</LinkedDate>
    </ParentDocument>
  </LinkedDocumentsModel>
  <LinkedDocumentsModel>
    <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:34:30.2758827-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:34:30.2758827-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:34:30.2758827-05:00</LinkedDate>
    </ParentDocument>
  </LinkedDocumentsModel>
</ArrayOfLinkedDocumentsModel>