This transaction is meant for
adding Annotation Groups on a particular page of a document. AnnotationBuffer
is the actual Annotations on the document and AnnotationData is the binary data
(Image Stamps).
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOAdd Annotation |
N/A |
|
CabinetName |
Root |
Name of the Cabinet to which the
User wants to connect. |
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 |
|
AnnotationGroup |
Root |
The Annotation Group that is to be added. |
|
|
|
AccessType |
Annotation Group |
The type of Access on the annotation S, I, P. |
‘S’ – shared ‘I’ – inherited ‘P’ – private |
‘I’ |
|
PageNo |
Annotation Group |
The Page Number on which the current Annotation Group has
been applied. |
Integer >=0 and <= Total Pages |
0 |
|
AnnotGroup Name |
Annotation Group |
The name of the Annotation Group. |
The name of Annotation
Group. |
Default |
|
CreationDate Time |
Annotation Group |
The Date and Time at which the Annotation is being
created. |
Valid Date in the format- yyyy-mm-dd hh:mm:ss |
Current Date and Time |
|
AnnotationBuffer |
Annotation Group |
The Annotation Data. |
The Annotation Data in annotation format. |
N/A |
|
AnnotationType |
AnnotationGroup |
Type of annotation (like notesheet or Annotation) |
|
N/A |
|
AnnotationData |
Annotation Group |
Reserved for internal use. |
|
|
|
OwnerIndex |
Annotation Group |
The Owner Index of the Owner of the Annotation Group. |
Integer>=0 |
By Default logged in User is the Owner of Annotations. |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
Unique name for the call. (NGOAddAnnotation) |
|
Status |
Root |
Status of the call. If it is 0, then call is successful. |
|
AnnotationGroup |
Root |
Contains the added Annotation. |
|
AccessType |
AnnotationGroup |
Type of Access on the Annotation Group added. ‘P’ – private ‘I’ – inherited ‘S’ – shared |
|
AnnotGroupIndex |
AnnotationGroup |
The Annotation Group Index of the Annotation Group that
has been added. |
|
AnnotationType |
AnnotationGroup |
Type of Annotation. If no value is returned, then the
Annotations are Image Annotations. If
‘N’ is returned then it is text annotation (notes). |
|
PageNo |
AnnotationGroup |
The page number on which the annotation group has been
added. |
|
AnnotGroupName |
AnnotationGroup |
The name of the added Annotation Group. |
|
CreationDateTime |
AnnotationGroup |
The creation Date and Time of the added Annotation Group. |
|
AnnotationBuffer |
AnnotationGroup |
The buffer containing the Annotations of the added
Annotation Group. |
|
Owner |
AnnotationGroup |
The name of the Owner of the added Annotation Group. |
|
Code |
Message |
Comments |
|
-50025 |
Document
not found. |
Document
with the specified Document Index does not exist. |
|
-50071 |
Document
has been checked out |
The
specified document has been checked out. User cannot add Annotations when
document is checked out. |
|
-50022 |
Insufficient
rights for the current operation. |
The
logged in User does not possess sufficient rights to add Annotations to the
document. |
|
-50056 |
Page not
found. |
The page
on which Annotations are being added does not exist. |
|
-50090 |
Annotation
with the same name already exists. |
An
Annotation Group with same name as that of the Annotation Group being added
already exists. |
|
-50074 |
Invalid
parameters. |
Some of
the entered parameters are incorrect. |
|
-50003 |
User does
not exist. |
Specified
User whom you want to make Owner of the Annotation does not exist. |