NGOModifyAnnotation

This transaction is used to modify an existing Annotation Group. User has to send those tags that are to be modified in this call. All other values are retained. User has to pass either Annotation Name or Annotation Index to modify it. Whenever any Annotation is modified for a document and if AutoVersioning is “Y” for document and SuppAutoVersionFlag is passed as “N” in the input, a new Version is created for the document.

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.	NGOModify Annotation	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
VersionNo	Root	The Version of the document whose Annotations have to be modified.	X .Y where X >0 and Y >=0	Current Version of the document.
LimitCount	Root	The number of Versions to limit.	Integer >= 0	NULL
AnnotationGroup	Root	The Annotation Group that has to be modified.		N/A
AccessType	Annotation Group	The type of Access S, I, P	‘S’ – shared ‘I’ – inherited ‘P’ – private	‘I’
AnnotGroup Index	Annotation Group	The Group Index of the Annotation Group to be modified.	Integer>=0	N/A
AnnotGroup Name	Annotation Group	The name of the Annotation Group to be modified.	The name of Annotation Group.	Default
AnnotationBuffer	Annotation Group	The Annotation Data.	The Annotation data in Annotation format.	NULL
AnnotationData	AnnotationGroup
OwnerIndexOwnerIndex	Annotation Group	Owner of the Annotation Group.	A valid Owner Index.
FinalizedFlag	Annotation Group	Whether the Annotation Group has been finalized or not.	‘Y’ – yes and ‘N’ – no	‘N’

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.
AccessType	Annotation GroupRoot	Type of Access on the modified Annotation Group. S – shared I – inherited, P – Private
AnnotGroupIndex	Annotation GroupRoot	The Index of the modified Annotation Group.
AnnotationType	Annotation GroupRoot	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	RootAnnotation Group	The Page Number whose Annotations have been modified.
AnnotGroupName	RootAnnotation Group	Name of the Annotation Group modified.
CreationDateTime	RootAnnotation Group	Date and Time at which modified Annotation Group was created.
AnnotationBuffer	RootAnnotation Group	The actual Annotation data.
LoginUserRights	RootAnnotation Group	The Rights of currently logged in User who has modified the Annotation Group.
Owner	RootAnnotation Group	Owner of the modified Annotation Group.
RevisedDateTime	RootAnnotation Group	The Date and Time at which the Annotation Group was modified.
FinalizedFlag	RootAnnotation Group	Whether the modified Annotation Group has been finalized or not. ‘Y’ – yes and ‘N’ – no
FinalizedDateTime	RootAnnotation Group	The Date and Time at which the Annotation Group was finalized.
FinalizedBy	RootAnnotation Group	The name of the User who finalized the Annotation Group.

Errors returned from call

Code	Message	Comments
-50025	Document not found.	Document with the specified Document Index does not exist.
-50111	The specified Version of the Document does not exist.	The specified Version of the Document does not exist.
-50022	Insufficient rights for the current operation.	The logged in User does not possess sufficient Rights to modify the document.
-50035	Annotation not found.	The specified Annotation Group does not exist.
-50183	Object has been Finalized.	The Annotation Group being modified has been finalized.
-50138	User not Owner or supervisor.	This exception will come when User tries to change the Owner of Annotation Only Owner or Supervisor can change the ownership of the Annotation.
-50003	User does not exist.	The specified User who has to be made the new Owner of the Annotation does not exist in the System.
-50006	User account has expired.	The account of the specified User who has to be made the new Owner of the Annotation has expired.
-50010	User not alive.	The specified User who has to be made the new Owner of the Annotation has been temporarily suspened by supervisor
-50061	Insufficient rights for current operation.	The logged in User does not possess sufficient Rights to modify the Annotation Group. User must have Change Rights to modify the Annotations.
-50174	Limit on number of Versions exceeded.	This exception can come when AutoVersioning is set for the document and User has specified suppautoVersionNing as “N”,in that case a new Version is created for the document and while creating Version if limit on number of Versions exceeded.
-50132	Document has been deleted.	Document has been deleted from the System.
-50026	Document is in use.	Document is locked by some other User.
-50027	Properties of the Document have been finalized.	Properties of the document have been finalized.
-50053	Check rights failed.	Check Rights operation failed internally.