GET api/Signing/{signingRoomId}/Documents/{documentId}/Annotations

Gets the document annotations for the document 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

Name	Description	Type	Additional information
signingRoomId	The id of the SigningRoom.	integer	Required
documentId	The id of the document.	integer	Required

Body Parameters

None.

Response Information

Resource Description

The list of document annotations for the specified document.

Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.Tagging.AnnotationModel

Name	Description	Type	Additional information
PopulatedDate	Gets or sets the date and time when the annotation was populated.	date	None.
AnnotationValue	Gets or sets the annotation value.	string	None.
DocumentAnnotationId	Gets or sets document annotation identifier.	integer	None.
DocumentSignerId	Gets or sets document signer identifier.	integer	None.
DocumentId	Gets or sets the document identifier.	integer	None.
ParticipantId	Gets or sets the participant identifier.	integer	None.
ParticipantOrderId	Gets or sets the participant order identifier.	integer	None.
XOffset	Gets or sets XOffset for the annotation.	decimal number	Required
YOffset	Gets or sets YOffset for the annotation.	decimal number	Required
AnnotationTypeId	Gets the annotation's annotation type identifier.	integer	None.
AnnotationType	Gets or sets the annotation's annotation type.	string	None.
DisplayValue	Gets or sets the annotation's display value.	string	None.
Width	Gets or sets width of the annotation.	decimal number	Required
Height	Gets or sets height of the annotation.	decimal number	Required
Optional	Gets or sets a value indicating whether the document annotation is optional.	boolean	Required
PageNumber	Gets or sets page number for the annotation.	integer	Required
MaxAnnotationTextLength	Gets or sets the maximum length of the annotation text.	integer	None.
AnnotationTextFontSize	Gets or sets the font size of the text to be entered into a textbox annotation.	integer	None.
Deleted	Gets or sets a value indicating whether the annotation is deleted.	boolean	None.
FittextValue	Gets or sets a value to be used for fittext in the tagging UI.	decimal number	None.
AnnotationGroupName	Gets or sets the group name for a set of annotations where only one should have a value. Primarily used for making checkboxes act as radio buttons.	string	None.
SignatureReferenceId	Gets or sets the signature reference identifier for a smart document.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PopulatedDate": "2026-01-01T17:32:20.1310225-05:00",
    "AnnotationValue": "sample string 1",
    "DocumentAnnotationId": 1,
    "DocumentSignerId": 1,
    "DocumentId": 1,
    "ParticipantId": 1,
    "ParticipantOrderId": 1,
    "XOffset": 2.1,
    "YOffset": 3.1,
    "AnnotationTypeId": 4,
    "AnnotationType": "sample string 5",
    "DisplayValue": "sample string 6",
    "Width": 7.1,
    "Height": 8.1,
    "Optional": true,
    "PageNumber": 10,
    "MaxAnnotationTextLength": 1,
    "AnnotationTextFontSize": 1,
    "Deleted": true,
    "FittextValue": 12.1,
    "AnnotationGroupName": "sample string 13",
    "SignatureReferenceId": "sample string 14"
  },
  {
    "PopulatedDate": "2026-01-01T17:32:20.1310225-05:00",
    "AnnotationValue": "sample string 1",
    "DocumentAnnotationId": 1,
    "DocumentSignerId": 1,
    "DocumentId": 1,
    "ParticipantId": 1,
    "ParticipantOrderId": 1,
    "XOffset": 2.1,
    "YOffset": 3.1,
    "AnnotationTypeId": 4,
    "AnnotationType": "sample string 5",
    "DisplayValue": "sample string 6",
    "Width": 7.1,
    "Height": 8.1,
    "Optional": true,
    "PageNumber": 10,
    "MaxAnnotationTextLength": 1,
    "AnnotationTextFontSize": 1,
    "Deleted": true,
    "FittextValue": 12.1,
    "AnnotationGroupName": "sample string 13",
    "SignatureReferenceId": "sample string 14"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAnnotationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager.Tagging">
  <AnnotationModel>
    <AnnotationGroupName>sample string 13</AnnotationGroupName>
    <AnnotationTextFontSize>1</AnnotationTextFontSize>
    <AnnotationType>sample string 5</AnnotationType>
    <AnnotationTypeId>4</AnnotationTypeId>
    <Deleted>true</Deleted>
    <DisplayValue>sample string 6</DisplayValue>
    <DocumentAnnotationId>1</DocumentAnnotationId>
    <DocumentId>1</DocumentId>
    <DocumentSignerId>1</DocumentSignerId>
    <FittextValue>12.1</FittextValue>
    <Height>8.1</Height>
    <MaxAnnotationTextLength>1</MaxAnnotationTextLength>
    <Optional>true</Optional>
    <PageNumber>10</PageNumber>
    <ParticipantId>1</ParticipantId>
    <ParticipantOrderId>1</ParticipantOrderId>
    <SignatureReferenceId>sample string 14</SignatureReferenceId>
    <Width>7.1</Width>
    <XOffset>2.1</XOffset>
    <YOffset>3.1</YOffset>
    <AnnotationValue>sample string 1</AnnotationValue>
    <PopulatedDate>2026-01-01T17:32:20.1310225-05:00</PopulatedDate>
  </AnnotationModel>
  <AnnotationModel>
    <AnnotationGroupName>sample string 13</AnnotationGroupName>
    <AnnotationTextFontSize>1</AnnotationTextFontSize>
    <AnnotationType>sample string 5</AnnotationType>
    <AnnotationTypeId>4</AnnotationTypeId>
    <Deleted>true</Deleted>
    <DisplayValue>sample string 6</DisplayValue>
    <DocumentAnnotationId>1</DocumentAnnotationId>
    <DocumentId>1</DocumentId>
    <DocumentSignerId>1</DocumentSignerId>
    <FittextValue>12.1</FittextValue>
    <Height>8.1</Height>
    <MaxAnnotationTextLength>1</MaxAnnotationTextLength>
    <Optional>true</Optional>
    <PageNumber>10</PageNumber>
    <ParticipantId>1</ParticipantId>
    <ParticipantOrderId>1</ParticipantOrderId>
    <SignatureReferenceId>sample string 14</SignatureReferenceId>
    <Width>7.1</Width>
    <XOffset>2.1</XOffset>
    <YOffset>3.1</YOffset>
    <AnnotationValue>sample string 1</AnnotationValue>
    <PopulatedDate>2026-01-01T17:32:20.1310225-05:00</PopulatedDate>
  </AnnotationModel>
</ArrayOfAnnotationModel>