NGOGetAnnotationGroupList

This call is used to get the Annotation Groups on a document for a particular page and particular Version.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml
Errors and Warnings

Input Parameters description

Name	Parent Tag	Description	Valid Values	Default Values
Option	Root	Unique option for the call.	NGOGetAnnotation GroupList	N/A
CabinetName	Root	Name of the Cabinet to which the User wants to connect.	The name of the Cabinet.	N/A
UserDBId	Root	UserDatabase ID that is returned in the NGOConnect Cabinet call.		N/A
DocumentIndex	Root	Unique Index of the document.	Integer > 0	N/A
PageNo	Root	The page number whose Annotations have to be fetched.	Integer >= 1 and <= Total pages 0 if all Annotations on all pages are to be retrieved.	0
AnnotationType	Root	Type of Annotations to be fetched.	A- A B-
Previous AnnotationIndex	Root	Index of the last Annotation of the previous batch.	Integer >= 0	0
VersionNo	Root	The Version of the document whose Annotations have to be fetched.	X .Y where X >0 and Y >=0	Current Version
SortOrder	Root	The order in which the Annotations would be retrieved. The order corresponds to the chronological order in which the Annotations were added.	‘A’ - Ascending ‘D’- Descending	A
NoOfRecordsTo Fetch	Root	Number of Annotations to be retrieved. This is used when the Annotations are to be retrieved in batches.	Integer > 0	Specified when the cabinet is configured.

Output Parameters description

Name	Parent Tag	Description
Option	Root	Unique option for the call.
Status	Root	Status of the call. If the Status is 0, then the call is successful.
NoOfRecordsFetched	Root	Total number of Annotations retrieved.
TotalNoOfRecords	Root	This parameter is either equal to NoOfRecordsFetched or one greater than it. In the former case it signifies that all the Annotations with index > PreviousAnnotationIndex have been retrieved. In the latter it signifies that more Annotations are left.
AnnotationGroups	Root	Contains information about all the retrieved Annotations in <AnnotationGroup> and </AnnotationGroup> tag.
AnnotationGroup	Annotation Groups	Contains information of a particular Annotation.
AccessType	Annotation Group	Type of Access on the Annotation Group. S – shared. I – inherited, P – Private
AnnotGroupIndex	Annotation Group	The index of the Annotation Group to which the Annotation belongs.
AnnotationType	Annotation Group	Type of Annotation. If no value is returned then the Annotations are image Annotations else if ‘N’ is returned then it is text Annotation (Notes).
PageNo	Annotation Group	The page number to which the Annotation belongs.
AnnotGroupName	Annotation Group	Name of the Annotation Group to which the Annotation belongs.
CreationDateTime	Annotation Group	Date and Time on which the Annotation Group was created.
AnnotationBuffer	Annotation Group	The actual Annotation Data.
LoginUserRights	Annotation Group	The Rights of currently logged in User who is trying to retrieve the Annotations of the Group.
Owner	Annotation Group	Owner of the Annotation Group.
RevisedDateTime	Annotation Group	The Date and Time at which the Annotation Group was last changed.
FinalizedFlag	Annotation Group	Whether the Annotation Group has been finalized or not. ‘Y’ – yes and ‘N’ – no
FinalizedDateTime	Annotation Group	The Date and Time at which the Annotation Group was finalized.
FinalizedBy	Annotation Group	Index of the User who finalized the Annotation Group.

Errors returned from call

Code	Message	Comments
-50023	Document not found.	Document with the specified document Index does not exist.
-50022	Insufficient rights for the current operation.	The logged in User does not possess sufficient Rights on the Document. User must have read Rights on Document.
-50032	Insufficient rights for the current operation.	This exception comes when User does not have Rights on the Data Class associated with Document, User must have atleast Read Rights on the Data Class associated with the document.