Skip to end of metadata
Go to start of metadata
Contents Summary

  

Introduction

GroupDocs.Annotation Cloud API provides annotation data from supported file formats as AnnotationInfo Object.

AnnotationInfo object fields

guid

string

The unique identifier of annotation.

documentGuid

long

The unique identifier of document.

text

string

The text of the annotation.

creatorGuid

string

The annotation creator unique identifier.

creatorName

string

The annotation creator name.

creatorEmail

string

The annotation creator email.

box

Rectangle

The frame of the annotation.

pageNumber

int

The annotation page number.

annotationPosition

Point

Coordinates of annotation point or row and column for cells document.

svgPath

string

The annotation svg-path.

type

AnnotationType

The annotation type.Enum that represents all types of annotations.

access

AnnotationAccess

The annotation access.

replies

AnnotationReplyInfo[]

The list of annotation replies.

createdOn

DateTime

The annotation creation date.

fontColor

int

The annotaiton text font color.

penColor

int

The annotaiton pen color.

penWidth

byte

The annotaiton pen width.

penStyle

byte

The annotaiton pen style.

backgroundColor

int

The annotaiton background color.

fieldText

string

The annotaiton text font color.

fontFamily

string

The annotaiton text font family.

fontSize

double

The annotaiton text font size.

 

Point object fields

x

Double

The x coordinate.

y

Double

The y coordinate.

 

AnnotationReplyInfo object fields

Guid

string

The unique identifier of reply.

UserGuid

string

The unique identifier of user.

UserName

string

The user name.

UserEmail

string

The user email.

Message

string

The reply message.

RepliedOn

DateTime

The reply creation date.

ParentReplyGuid

string

The unique identifier of parent reply.

 

Rectangle object fields 

x

float

The x coordinate.

y

float

The y coordinate.

width

float

The rectangle width.

height

float

The rectangle height.

The emuneration of Annotation types

 

Import Annotation Information

This API retrieves(imports) annotation information from the document. It returns the list of annotations which were imported from the document.

Resource

The following GroupDocs.Annotation Cloud REST API resource has been used to get annotation list from document.

cURL REST Example

 Request
 Response

SDKs

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

Import Annotation Information

 C#
 PHP
 Java
 Ruby

Export Annotation

This API adds(exports) annotation to a document and retrieves the resultant document as stream. It expects AnnotaitonInfo object in request body.

Resource

The following GroupDocs.Annotation Cloud REST API resource has been used to add Annotation and get resultant document as stream.

cURL REST Example

 Request
 Response

SDKs

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

Export Annotation and get Document as Stream

 C#
 PHP
 Java
 Ruby

Remove Annotation

This API removes annotation from a document and retrieves the resultant document as stream.

Resource

The following GroupDocs.Annotation Cloud REST API resource has been used to remove Annotation and get resultant document as stream.

cURL REST Example

 Request
 Response

SDKs

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

Remove Annotation and get Document as Stream

 C#
 PHP
 Java
 Ruby
Labels
  • No labels