GetPageAnnotation

Description

Returns with the JSON Array of the Annotations, and their properties from a document page stored in hard drive.

Method Type

POST

URL

api/annotation/page-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.
Page	Int	The page number of the document.

Response Type

JSON (JsonResult)

Return values

{

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

}

Programming notes

None

Example

None

Requirements