Function Name: getGetAnnotationGroupListXml
Class: com.newgen.dmsapi.DMSInputXml
Description: This function is used to fetch the Annotation Groups on a particular Page or all the Pages of the document.
|
|
Prototype:
public String getGetAnnotationGroupListXml(String cabinetName, String userDbId,
String docIndex, String pageNo,
String prevAnnotIndex, String versionNo,
String noOfRecordsToFetch,
String sortOrder, String annotationType)
|
Name |
Description |
Valid Values |
Default Behaviour |
|
CabinetName |
Name of the Database Cabinet to which the User wants to connect. |
The name of the Cabinet. |
N/A |
|
UserDbId |
UserDatabase ID, which is returned in the ConnectCabinet call. |
|
N/A |
|
DocIndex |
Unique Index of the document. |
Integer > 0 |
N/A |
|
PageNo |
The Page Number whose Annotations have to be fetched. |
Integer >= 1 and <= Total pages
0 if all the Annotations on all Pages are to be retrieved. |
0 |
|
PrevAnnotIndex |
Index of the last Annotation of the previous batch. |
Integer >= 0 |
0 |
|
VersionNo |
The Version of the document whose Annotations have to be fetched. |
X .Y where X >0 and Y >=0 Example,1.0 |
Current Version |
|
SortOrder |
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 |
Number of Annotations to be retrieved. This is used when the Annotations are to be retrieved in batches. |
Integer > 0 |
N/A |
|
AnnotationType |
Type of Annotation, Image or Non Image (notes).
|
‘N’ – Notes ‘A’ - Annotations |
N/A |
An Input Xml for NGOGetAnnotationGroupList.