GET api/Documents/{documentId}
Allows a client admin or a SigningRoom admin to get the specified document.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| documentId |
The document identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The specified document.
ESignSystems.SmartSAFE.Models.SigningRoomManager.DocumentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentId |
Gets or sets the document identifier. |
integer |
None. |
| ClientId |
Gets or sets the document's client identifier. |
integer |
None. |
| SigningRoomId |
Gets or sets the document's SigningRoom identifier. |
integer |
None. |
| DocumentTypeId |
Gets or sets the document's document type identifier. |
integer |
None. |
| DocumentType |
Gets or sets the document's document type. |
string |
None. |
| DocumentGuid |
Gets or sets the document's GUID. |
string |
Max length: 128 |
| DocumentName |
Gets or sets the document's name. |
string |
Required Max length: 256 |
| Description |
Gets or sets the document's description. |
string |
Max length: 500 |
| PageCount |
Gets or sets the document's page count. |
integer |
None. |
| FileExtension |
Gets or sets the document's file extension. |
string |
Max length: 10 |
| MimeType |
Gets or sets the document's mime type. |
string |
None. |
| IsPDF |
Gets a value indicating whether the document is a PDF. |
boolean |
None. |
| UDF1 |
Gets or sets the first user defined field. |
string |
Max length: 256 |
| UDF2 |
Gets or sets the second user defined field. |
string |
Max length: 256 |
| UDF3 |
Gets or sets the third user defined field. |
string |
Max length: 256 |
| Signed |
Gets or sets a value indicating whether at least one document signer has signed the document. |
boolean |
None. |
| SigningComplete |
Gets or sets a value indicating whether all document signers have signed the document. |
boolean |
None. |
| ClientName |
Gets or sets the name of the client that the document is associated to. |
string |
None. |
| SigningRoomName |
Gets or sets the name of the SigningRoom that the document is associated to. |
string |
None. |
| HasAnnotations |
Gets or sets the value indicating whether the document has annotations. |
boolean |
None. |
| HasSigners |
Gets or sets the value indicating whether the document has any signers. |
boolean |
None. |
| Reviewed |
Gets or sets a value indicating whether at least one document reviewer who is required to review the document has reviewed the document. |
boolean |
None. |
| ReviewingComplete |
Gets or sets a value indicating if the document is completely reviewed by those required to. |
boolean |
None. |
| Downloaded |
Gets or sets a value indicating whether the document has been downloaded. |
boolean |
None. |
| ParentDocumentId |
Gets or sets the parent document identifier. |
integer |
None. |
| Status |
Gets the status text for the document based on other fields. |
string |
None. |
| IsSmartDoc |
Gets or sets a value indicating if the document is a smart document. |
boolean |
None. |
| Archived |
Indicates whether the document is archived. |
boolean |
None. |
| CreatedBy |
Gets or sets the name of the user that created the document. |
string |
None. |
| CreatedDate |
Gets or sets the created date of the document. |
date |
None. |
| SignatureValidation |
Gets or sets the results of the signature validation of the document. |
ESignSystems.SmartSAFE.Models.Signing.SignatureValidationResult |
None. |
| ExternallySigned |
Gets or sets a value indicating if the document was externally signed. |
boolean |
None. |
| AuthoritativeCopy |
Indicates whether the smart document is an authoritative copy or not. |
boolean |
None. |
| PreviousAuthoritativeCopy |
Gets or sets a value indicating whether this has previously been an authoritative copy. |
boolean |
None. |
| MarkAsAuthoritativeCopyAfterSigning |
Gets or sets a value indicating whether the document being uploaded will become AuthoritativeCopy after it's finished being signed in a SigningRoom. |
boolean |
None. |
| TransferableRecord |
Gets or sets the value indicating if the document is a transferable record. |
boolean |
None. |
| IsTransferableDocOrSmartDoc |
Gets a value indicating whether this is an transferable document or an transferable smart document. |
boolean |
None. |
| IsAuthoritativeDocOrSmartDoc |
Gets a value indicating whether this is an authoritative document or an authoritative smart document. |
boolean |
None. |
| PrintAndSign |
Gets or sets a value indicating if document can be printed and signed. |
boolean |
None. |
| ENotary |
Gets or sets a value indicating if the document is an eNotary document. |
boolean |
None. |
| SortOrder |
Gets or sets the sort order. |
integer |
None. |
| Signable |
Gets the signable type. |
string |
None. |
| FolderId |
Gets or sets the folder identifier. |
integer |
None. |
| ParentFolderId |
Gets or sets the parent folder id. |
integer |
None. |
| ParentFolderName |
Gets or sets the parent folder name. |
string |
None. |
| MISMOVersionIdentifier |
Gets or sets the MISMO Version Identifier. |
string |
None. |
| SystemDocument |
Gets or sets a value indicating whether this document is a system document. |
boolean |
None. |
Response Formats
application/json, text/json
{
"DocumentId": 1,
"ClientId": 1,
"SigningRoomId": 1,
"DocumentTypeId": 1,
"DocumentType": "sample string 1",
"DocumentGuid": "sample string 2",
"DocumentName": "sample string 3",
"Description": "sample string 4",
"PageCount": 1,
"FileExtension": "sample string 5",
"MimeType": "sample string 6",
"IsPDF": true,
"UDF1": "sample string 8",
"UDF2": "sample string 9",
"UDF3": "sample string 10",
"Signed": true,
"SigningComplete": true,
"ClientName": "sample string 13",
"SigningRoomName": "sample string 14",
"HasAnnotations": true,
"HasSigners": true,
"Reviewed": true,
"ReviewingComplete": true,
"Downloaded": true,
"ParentDocumentId": 1,
"Status": "Complete",
"IsSmartDoc": true,
"Archived": true,
"CreatedBy": "sample string 22",
"CreatedDate": "2024-11-26T17:16:35.7090547-05:00",
"SignatureValidation": {
"Valid": true,
"InvalidReason": "sample string 2"
},
"ExternallySigned": true,
"AuthoritativeCopy": true,
"PreviousAuthoritativeCopy": true,
"MarkAsAuthoritativeCopyAfterSigning": true,
"TransferableRecord": true,
"IsTransferableDocOrSmartDoc": true,
"IsAuthoritativeDocOrSmartDoc": true,
"PrintAndSign": true,
"ENotary": true,
"SortOrder": 1,
"Signable": "eSign",
"FolderId": 1,
"ParentFolderId": 1,
"ParentFolderName": "sample string 30",
"MISMOVersionIdentifier": "sample string 31",
"SystemDocument": true
}
application/xml, text/xml
<DocumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">
<Archived>true</Archived>
<AuthoritativeCopy>true</AuthoritativeCopy>
<ClientId>1</ClientId>
<ClientName>sample string 13</ClientName>
<CreatedBy>sample string 22</CreatedBy>
<CreatedDate>2024-11-26T17:16:35.7090547-05:00</CreatedDate>
<Description>sample string 4</Description>
<DocumentGuid>sample string 2</DocumentGuid>
<DocumentId>1</DocumentId>
<DocumentName>sample string 3</DocumentName>
<DocumentType>sample string 1</DocumentType>
<DocumentTypeId>1</DocumentTypeId>
<Downloaded>true</Downloaded>
<ENotary>true</ENotary>
<ExternallySigned>true</ExternallySigned>
<FileExtension>sample string 5</FileExtension>
<FolderId>1</FolderId>
<HasAnnotations>true</HasAnnotations>
<HasSigners>true</HasSigners>
<IsAuthoritativeDocOrSmartDoc>true</IsAuthoritativeDocOrSmartDoc>
<IsPDF>true</IsPDF>
<IsSmartDoc>true</IsSmartDoc>
<IsTransferableDocOrSmartDoc>true</IsTransferableDocOrSmartDoc>
<MISMOVersionIdentifier>sample string 31</MISMOVersionIdentifier>
<MarkAsAuthoritativeCopyAfterSigning>true</MarkAsAuthoritativeCopyAfterSigning>
<MimeType>sample string 6</MimeType>
<PageCount>1</PageCount>
<ParentDocumentId>1</ParentDocumentId>
<ParentFolderId>1</ParentFolderId>
<ParentFolderName>sample string 30</ParentFolderName>
<PreviousAuthoritativeCopy>true</PreviousAuthoritativeCopy>
<PrintAndSign>true</PrintAndSign>
<Reviewed>true</Reviewed>
<ReviewingComplete>true</ReviewingComplete>
<SignatureValidation xmlns:d2p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
<d2p1:InvalidReason>sample string 2</d2p1:InvalidReason>
<d2p1:Valid>true</d2p1:Valid>
</SignatureValidation>
<Signed>true</Signed>
<SigningComplete>true</SigningComplete>
<SigningRoomId>1</SigningRoomId>
<SigningRoomName>sample string 14</SigningRoomName>
<SortOrder>1</SortOrder>
<SystemDocument>true</SystemDocument>
<TransferableRecord>true</TransferableRecord>
<UDF1>sample string 8</UDF1>
<UDF2>sample string 9</UDF2>
<UDF3>sample string 10</UDF3>
</DocumentModel>