GET api/Documents/{documentId}/PageImage/{pageNumber}

Allows a client admin, a SigningRoom admin, or a participant to get the page image of the specified document and page.

Request Information

URI Parameters

Name	Description	Type	Additional information
documentId	The document identifier.	integer	Required
pageNumber	The page number.	integer	Required

Body Parameters

None.

Response Information

Resource Description

The specified page image.

ESignSystems.SmartSAFE.Models.SigningRoomManager.Tagging.DocumentPageImageModel

Name	Description	Type	Additional 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>