GetMultiPageAnnotation

Description

Returns with the JSON Array of the Pages, containing Annotations, and their properties from the document pages between PageFrom and PageTo.

Method Type

POST

URL

api/annotation/multipage-annotations

Parameters

Name

Type

Description

DocumentID

Object

The specified document’s DocumentID.

 

The DocumentID can be any object, for example an absolute path of a file, or a database row ID. The specified Content-Engine will interpret the DocumentID and serve the document.

CE (Optional)

String

The Specified Content-Engine.

 

Possible values:

0: Default Content-Engine (default)

1: FileEngine

2: DatabaseEngine

AnnotationFile (Optional)

String

An external annotation file. If the annotation file exist, the IceViewer HTML5 will load the annotations only from the annotation file.

Config (Optional)

String

The Session Configuration identifier.

PageFrom

Int

The first page to get the annotations from.

PageTo

Int

The last page to get the annotations from.

Response Type

JSON (JsonResult)

Return values

{

pages (String) [Serialized Object of List<List<Annotations.AnnotationObjectClient>>]

}

 

Programming notes

This API supports both documents stored in the database, or stored on the hard-drive.

 

Example

None

 

Requirements