NGOCreateDocumentVersion

This call is used to create a new Version for the specified document. For example, if the current Document Version of a document is “1.1”, then the call will create a new Version “1.2” 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.	NGOCreate DocumentVersion	N/A
CabinetName	Root	Name of the Cabinet to which the User wants to connect.		N/A
UserDBId	Root	UserDatabase ID, which is returned in the NGOConnect Cabinet call.		N/A
CurrentDateTime	Root	It indicates the current Date and Time when call is made.	CurrentDateTime	Current Date Time
DocumentIndex	Root	It indicates the unique Index of the document.	Integer>=0	N/A
VersionNo	Root	NOT USED in this call.		N/A
LimitCount	Root	If the User wants to limit the number of Versions for a document, then the Limit Count should be specified in <LimitCount> tag.		No limit check is done on Version count.
VersionComment	Root	Any Comment associated with the document while creating a new Version.		Blank
SupAnnotVersion	Root	Specifies whether to suppress the carry forwarding of Annotations with the object Version or not.	Y – Do not keep the Annotations previously added when a new Version is added. N – Keep the Annotations of the old Version when a new Version is added.	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.
Document	Root	A list of information about the document is given between the <Document> and </Document> tags.
DocumentIndex	Document	It indicates the unique Index of the document.
ParentFolderIndex	Document	Index of the Parent Folder of the document.
DocumentVersionNo	Document	Version of the current document.
NoOfPageNos	Document	Number of pages of the document.
DocumentName	Document	It specifies the Document Name.
OwnerAuthor	Document	Specifies the Owner of the document.
CreationDateTime	Document	It indicates the creation Date and Time of the document.
RevisedDateTime	Document	Date and Time when the folder was last revised.
AccessDateTime	Document	Date and Time when the object was last accessed.
DataDefNameDataDefIndex	DataDefinitionDocument	IndexName of the Data Class associated with the document.
VersionFlag	Document	Specifies whether Versioning is allowed. Y – Versioning is allowed. N – Versioning is not allowed.
AccessType	Document	Specifies the scope of accessing the object.
DocumentSize	Document	Size of document in bytes.
DocumentType	Document	It indicates the type of the document.
DocumentLock	Document	Flag to indicate whether document is locked or not.
FinalisedFlag	Document	Flag, which specifies whether the object is finalized. Y- Object is finalized. N – Object is not finalized.
DocStatus	Document	Specifies the Status of the document. R – Read A – Unread
CheckOutStatus	Document	Flag that specifies the CheckOut status of the document. Y – Document is checked out. N – Document is not checked out.
DocOrderNo	Document	The order in which the document was added to the folder.
OMDADocumentIndex	Document	Not used.
CreatedByAppName	Document	It indicates the Extension of the document. For example JPG, GIF etc.
EnableLog	Document	Flag that specifies whether to generate log for the object. Y – Log is generated. N – Log not generated.
CreatedByApp	Document	Reserved for internal use.
FTSDocumentIndex	Document	Reserved for internal use.
Comment	Document	Comments added by User on the object.
FTSFlag	Document	Reserved for internal use.
ExpiryDateTime	Document	Date and Time when the Object Expires.
FinalizedDateTime	Document	Date and Time when the object was finalized.
CheckoutBy	Document	Index of the User who has checked out the document.
ACL	Document	String comprising the Rights of Users / Groups on the current document.
ACLMoreFlag	Document	Reserved
LoginUserRights	Document	Rights of the logged in User on the Document.
ISIndex	Document	Specifies a unique Combination of the Image Index and Volume Index for a document stored on the Image Server separated by #. For example, 3#79.

Errors returned from call

Code	Message	Comments
-50174	Limit on number of Versions exceeded.	Document Version could not be created as the number of Versions exceeded the limit.
-50023	Document not found.	Document whose Version is to be created does not exist.
-50132	Document has been deleted.	Document whose Version is to be created has been deleted.
-50053	Check rights failed.	Process of getting the Rights of the logged in User on document failed.
-50022	Insufficient rights for the current operation.	Logged in User does not have sufficient Rights on the document whose Version is to be created.
-50026	Document is in use.	Document whose Version is to be created has been locked.
-50027	Properties of the Document have been finalized.	Document whose Version is to be created has been finalized.
-50071	Document has been checked out.	Document whose Version is to be created is checked out.