GET api/Signing/{signingRoomId}/Documents/{documentId}/SmartDoc/ExternalReferences?fileName={fileName}

Gets the external references for the SMART Doc® with the specified document id in the specified SigningRoom. The current signer user must have access to the SigningRoom that contains the document and must have review or sign privileges on the document.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
signingRoomId

The id of the SigningRoom.

integer

Required

documentId

The id of the document.

integer

Required

fileName

The file name.

string

Required

Body Parameters

None.

Response Information

Resource Description

The external references of the SMART Doc®.

ESignSystems.SmartSAFE.Models.SigningRoomManager.Tagging.DocumentPageImageModel
NameDescriptionTypeAdditional information
Image

Gets or sets a byte array representing the image.

Collection of byte

None.

DocumentId

Gets or sets the document identifier.

integer

None.

PageNumber

Gets or sets the page number.

integer

None.

MimeType

Gets or sets the mime type.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Image": "QEA=",
  "DocumentId": 1,
  "PageNumber": 1,
  "MimeType": "sample string 2"
}

application/xml, text/xml

Sample:
<DocumentPageImageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager.Tagging">
  <DocumentId>1</DocumentId>
  <Image>QEA=</Image>
  <MimeType>sample string 2</MimeType>
  <PageNumber>1</PageNumber>
</DocumentPageImageModel>