POST api/Folders/Items/Download

Downloads the folder items.

Request Information

URI Parameters

None.

Body Parameters

The folder items.

Collection of ESignSystems.SmartSAFE.Models.Folders.FolderItemModel

Name	Description	Type	Additional information
FolderId	Gets or sets the folder identifier.	integer	None.
DocumentId	Gets or sets the document identifier.	integer	None.
ParentFolderId	Gets or sets the parent folder identifier.	integer	None.
ParentDocumentId	Gets or sets the parent document identifier.	integer	None.
ClientId	Gets or sets the client identifier.	integer	None.
Name	Gets or sets the name.	string	None.
CreatedDate	Gets or sets the created date.	date	None.
SigningRoomId	Gets or sets the signing room identifier.	integer	None.
FileExtension	Gets or sets the file extension.	string	None.
ItemType	Gets or sets the type of folder item.	string	None.
IsSmartDoc	Gets or sets the value indicating whether this folder item is a smart document.	boolean	None.
MISMOVersionIdentifier	Gets or sets the MISMO Version Identifier	string	None.
AuthoritativeCopy	Indicates whether the pdf document is an authoritative copy or not.	boolean	None.
HasDocumentChildren	Gets or sets whether the document has children.	boolean	None.
Archived	Gets or sets whether the document is archived.	boolean	None.
SystemDocument	Gets or sets whether the document is a system document.	boolean	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "FolderId": 1,
    "DocumentId": 1,
    "ParentFolderId": 1,
    "ParentDocumentId": 1,
    "ClientId": 1,
    "Name": "sample string 2",
    "CreatedDate": "2024-11-26T17:24:31.2161538-05:00",
    "SigningRoomId": 1,
    "FileExtension": "sample string 3",
    "ItemType": "sample string 4",
    "IsSmartDoc": true,
    "MISMOVersionIdentifier": "sample string 6",
    "AuthoritativeCopy": true,
    "HasDocumentChildren": true,
    "Archived": true,
    "SystemDocument": true
  },
  {
    "FolderId": 1,
    "DocumentId": 1,
    "ParentFolderId": 1,
    "ParentDocumentId": 1,
    "ClientId": 1,
    "Name": "sample string 2",
    "CreatedDate": "2024-11-26T17:24:31.2161538-05:00",
    "SigningRoomId": 1,
    "FileExtension": "sample string 3",
    "ItemType": "sample string 4",
    "IsSmartDoc": true,
    "MISMOVersionIdentifier": "sample string 6",
    "AuthoritativeCopy": true,
    "HasDocumentChildren": true,
    "Archived": true,
    "SystemDocument": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfFolderItemModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Folders">
  <FolderItemModel>
    <Archived>true</Archived>
    <AuthoritativeCopy>true</AuthoritativeCopy>
    <ClientId>1</ClientId>
    <CreatedDate>2024-11-26T17:24:31.2161538-05:00</CreatedDate>
    <DocumentId>1</DocumentId>
    <FileExtension>sample string 3</FileExtension>
    <FolderId>1</FolderId>
    <HasDocumentChildren>true</HasDocumentChildren>
    <IsSmartDoc>true</IsSmartDoc>
    <ItemType>sample string 4</ItemType>
    <MISMOVersionIdentifier>sample string 6</MISMOVersionIdentifier>
    <Name>sample string 2</Name>
    <ParentDocumentId>1</ParentDocumentId>
    <ParentFolderId>1</ParentFolderId>
    <SigningRoomId>1</SigningRoomId>
    <SystemDocument>true</SystemDocument>
  </FolderItemModel>
  <FolderItemModel>
    <Archived>true</Archived>
    <AuthoritativeCopy>true</AuthoritativeCopy>
    <ClientId>1</ClientId>
    <CreatedDate>2024-11-26T17:24:31.2161538-05:00</CreatedDate>
    <DocumentId>1</DocumentId>
    <FileExtension>sample string 3</FileExtension>
    <FolderId>1</FolderId>
    <HasDocumentChildren>true</HasDocumentChildren>
    <IsSmartDoc>true</IsSmartDoc>
    <ItemType>sample string 4</ItemType>
    <MISMOVersionIdentifier>sample string 6</MISMOVersionIdentifier>
    <Name>sample string 2</Name>
    <ParentDocumentId>1</ParentDocumentId>
    <ParentFolderId>1</ParentFolderId>
    <SigningRoomId>1</SigningRoomId>
    <SystemDocument>true</SystemDocument>
  </FolderItemModel>
</ArrayOfFolderItemModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The download folder item model.

ESignSystems.SmartSAFE.Models.Folders.DownloadFolderItemsModel

Name	Description	Type	Additional information
FolderItems	Gets or sets the folder items.	Collection of ESignSystems.SmartSAFE.Models.Folders.FolderItemModel	None.
File	Gets or sets the file.	Collection of byte	None.
FileName	Gets or sets the name of the file.	string	None.
MimeType	Gets or sets the mime type of the document to be downloaded.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "FolderItems": [
    {
      "FolderId": 1,
      "DocumentId": 1,
      "ParentFolderId": 1,
      "ParentDocumentId": 1,
      "ClientId": 1,
      "Name": "sample string 2",
      "CreatedDate": "2024-11-26T17:24:31.2161538-05:00",
      "SigningRoomId": 1,
      "FileExtension": "sample string 3",
      "ItemType": "sample string 4",
      "IsSmartDoc": true,
      "MISMOVersionIdentifier": "sample string 6",
      "AuthoritativeCopy": true,
      "HasDocumentChildren": true,
      "Archived": true,
      "SystemDocument": true
    },
    {
      "FolderId": 1,
      "DocumentId": 1,
      "ParentFolderId": 1,
      "ParentDocumentId": 1,
      "ClientId": 1,
      "Name": "sample string 2",
      "CreatedDate": "2024-11-26T17:24:31.2161538-05:00",
      "SigningRoomId": 1,
      "FileExtension": "sample string 3",
      "ItemType": "sample string 4",
      "IsSmartDoc": true,
      "MISMOVersionIdentifier": "sample string 6",
      "AuthoritativeCopy": true,
      "HasDocumentChildren": true,
      "Archived": true,
      "SystemDocument": true
    }
  ],
  "File": "QEA=",
  "FileName": "sample string 1",
  "MimeType": "sample string 2"
}

application/xml, text/xml

Sample:

<DownloadFolderItemsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Folders">
  <File>QEA=</File>
  <FileName>sample string 1</FileName>
  <FolderItems>
    <FolderItemModel>
      <Archived>true</Archived>
      <AuthoritativeCopy>true</AuthoritativeCopy>
      <ClientId>1</ClientId>
      <CreatedDate>2024-11-26T17:24:31.2161538-05:00</CreatedDate>
      <DocumentId>1</DocumentId>
      <FileExtension>sample string 3</FileExtension>
      <FolderId>1</FolderId>
      <HasDocumentChildren>true</HasDocumentChildren>
      <IsSmartDoc>true</IsSmartDoc>
      <ItemType>sample string 4</ItemType>
      <MISMOVersionIdentifier>sample string 6</MISMOVersionIdentifier>
      <Name>sample string 2</Name>
      <ParentDocumentId>1</ParentDocumentId>
      <ParentFolderId>1</ParentFolderId>
      <SigningRoomId>1</SigningRoomId>
      <SystemDocument>true</SystemDocument>
    </FolderItemModel>
    <FolderItemModel>
      <Archived>true</Archived>
      <AuthoritativeCopy>true</AuthoritativeCopy>
      <ClientId>1</ClientId>
      <CreatedDate>2024-11-26T17:24:31.2161538-05:00</CreatedDate>
      <DocumentId>1</DocumentId>
      <FileExtension>sample string 3</FileExtension>
      <FolderId>1</FolderId>
      <HasDocumentChildren>true</HasDocumentChildren>
      <IsSmartDoc>true</IsSmartDoc>
      <ItemType>sample string 4</ItemType>
      <MISMOVersionIdentifier>sample string 6</MISMOVersionIdentifier>
      <Name>sample string 2</Name>
      <ParentDocumentId>1</ParentDocumentId>
      <ParentFolderId>1</ParentFolderId>
      <SigningRoomId>1</SigningRoomId>
      <SystemDocument>true</SystemDocument>
    </FolderItemModel>
  </FolderItems>
  <MimeType>sample string 2</MimeType>
</DownloadFolderItemsModel>