NGOModifyDocumentVersion

This call is used to modify the Version Comment for an existing Version of a 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

DocumentVersion

N/A

CabinetName

Root

Name of the Cabinet to which the User wants to connect.

 

N/A

UserDBId

Root

UserDatabase ID that is returned in the NGOConnect

Cabinet call.

 

N/A

DocumentIndex

Root

It indicates the unique Index of the document whose Version Comment is to be modified.

 

N/A

VersionNo

Root

It indicates the Version Number of the document, which the User wants to set as the Current Version.

 

N/A

VersionComment

Root

This indicates the new Version Comment to be associated with the document.

 

N/A

 

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.

 

Errors returned from call

Code

Message

Comments

 -50111

Invalid Version For Document.

The document Version that the User wants to modify does not exist.

 -50022

Invalid rights on Document.

User does not have Rights on the document for which Version is to be modified. User must have Change Rights on that document.

 -50026

Document Locked.

When the document whose Version is being modified is locked.

 -50027

Document Finalized.

When the document whose Version is being modified is Finalized.

 -50071

Document check out.

When the document whose Version is being modified is checked out.

 -50032

Invalid rights on DDI.

When the User does not have Rights on the Data Class associated with the document for which Versions are to be modified.

-50076

Invalid object access type.

This error occurs while the Rights of the logged in User on the destination Folder, documents to be copied and the Annotations of the documents are checked.

-50028

 

Data Class not found.

Data Class that is associated with the document for which version is to be modified does not exist. This error occurs in the process of checking Rights on the Data Class. User should have atleast Read Rights on the Data Class.