Modify Annotation

Function Name: getModifyAnnotationXml

Class: com.newgen.dmsapi.DMSInputXml

Description: This function is used to modify an existing Annotation Group. In this call, User has to send those tags that need to be modified. The rest are sent as null and their previous values are maintained.

Input Parameters	Sample InputXML
Output Parameters	Sample OutputXML
View xml API::NGOModifyAnnotation

Prototype:

public String getModifyAnnotationXml	(
		String cabinetName,
		String userDbId,
		String documentIndex,
		String versionNo,
		String ownerIndex,
		String accessType,
		String annotGroupIndex,
		String pageNo,
		String annotGroupName,
		String creationDateTime,
		String annotationBuffer,
		String loginUserRights,
		String annotationData,
		String owner
	)

Input Parameters:

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
documentIndex	Unique Index of the document.	Integer >= 0	N/A
versionNo	The Version of the document whose Annotations have to be modified.	X .Y where X >0 and Y >=0	Current Version of the document.
ownerIndex	The User Index of the Owner of the Annotation Group that has to be modified.	OwnerIndex
accessType	The type of Access S,I,P.	‘S’ – shared ‘I’ – inherited ‘P’ – private	‘I’
annotGroupIndex	The Group Index of the Annotation Group that has to be modified.	Integer>=0	0
pageNo	The Page Number whose Annotations are to be modified.	Integer >=0 and <= Total Pages	0
annotGroupName	The Name of the Annotation Group that has to be modified.	The Name of the Annotation Group.	Default
creationDateTime	The Date and Time at which the specified Annotation Group was created.	Valid Date in the format- yyyy-mm-dd hh:mm:ss	Current Date and Time.
annotationBuffer	The Annotation data.	The Annotation data in Annotation format.	NULL
loginUserRights	The Rights of the currently logged in User.	A six-bit string	‘000000’
annotationData	The Annotation data. (same as annotationBuffer)	Binary data.	NULL
owner	Owner of this Annotation Group.	A valid Owner Index.	By default, the logged in User is taken as the Owner.

Output Parameters:

An Input Xml for NGOModifyAnnotation.