GET api/Documents/{documentId}/SmartDocument/Presentation
Gets the SmartDocument Presentation.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| documentId |
Id of the document. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
SmartDocument Presentation.
ESignSystems.SmartSAFE.Models.SmartDocuments.SmartDocumentPresentationModel| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentId |
Gets or sets the document identifier. |
integer |
None. |
| DocumentName |
Gets or sets the document name. |
string |
None. |
| Category |
Gets or sets the document category. |
string |
None. |
| PresentationData |
Gets or sets the document presentation data. |
string |
None. |
| ExternalReferences |
Gets or sets a list of ExternalReferenceModels. |
Collection of ESignSystems.SmartSAFE.Models.SmartDocuments.ExternalReferenceModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"DocumentId": 1,
"DocumentName": "sample string 1",
"Category": "sample string 2",
"PresentationData": "sample string 3",
"ExternalReferences": [
{
"Base64EncodedExternalReferenceData": "sample string 1",
"FileName": "sample string 2"
},
{
"Base64EncodedExternalReferenceData": "sample string 1",
"FileName": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<SmartDocumentPresentationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartDocuments">
<Category>sample string 2</Category>
<DocumentId>1</DocumentId>
<DocumentName>sample string 1</DocumentName>
<ExternalReferences>
<ExternalReferenceModel>
<Base64EncodedExternalReferenceData>sample string 1</Base64EncodedExternalReferenceData>
<FileName>sample string 2</FileName>
</ExternalReferenceModel>
<ExternalReferenceModel>
<Base64EncodedExternalReferenceData>sample string 1</Base64EncodedExternalReferenceData>
<FileName>sample string 2</FileName>
</ExternalReferenceModel>
</ExternalReferences>
<PresentationData>sample string 3</PresentationData>
</SmartDocumentPresentationModel>