NGOProcessLocks

The functionality of locking and unlocking of document, folder or Cabinet can be achieved using this transaction. By providing the VersionNo, any particular Version of a document can be locked.

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.	NGOProcess Locks	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
CurrentDate Time	Root	Date and Time when the document is being locked/unlocked.	Valid Date in the format- yyyy-mm-dd hh:mm:ss	Current System Date and Time.
Type	Root	Kind of the operation desired, namely lock or unlock.	‘Y’ – Lock ‘N’ – Unlock ‘A’ – Release all locks	N/A
VersionNo	Root	The Version of the document that is to be locked, or unlocked. Used only for Document Object.	X. Y where X>=1 and Y>=0	Latest Version of the document.
ObjectType	Root	Type of the object on which locking/unlocking operation is being performed.	‘D’– Document ‘F’ – Folder	NULL
ObjectIndex	Root	Index of the object on which locking/unlocking operation is being performed.	Integer >=0	N/A
LockMessage	Root	Lock message attached with the object.		NULL

Output Parameters description

Name	Parent Tag	Description
Option	Root	NGOProcessLocks
Status	Root	Status of the call. If the Status is 0, then the call is successful.
Type	Root	‘Y’ – Lock, ‘N’ – Unlock, ‘A’ – Release all Locks.

Errors returned from call

Code	Message	Comments
-50074	Invalid parameters.	Some of the parameters entered were incorrect.
-50147	Version is in use.	The specified Version could not be locked/unlocked because it is in use.
-50021	Folder is in use.	The specified Folder that is being locked/unlocked is already locked.
-50026	Document is in use.	The specified document that is being locked/unlocked is already locked.
-50018	Insufficient rights for the current operation.	The User who is trying to Lock/Unlock the Folder does not possess sufficient Rights to do so. User must have Change Rights to lock/unlock a Folder.
-50111	The specified Version of the Document does not exist.	The Version of the document specified for locking/unlocking does not exist.
-50023	Document not found.	The specified document that is being Locked / Unlocked does not exist.
-50022	Insufficient rights for the current operation.	The User who is trying to Lock / Unlock the document does not possess sufficient Rights to do so. User must have Change Rights to Lock / Unlock a document.
-50155	Document not locked.	The document or folder being unlocked has not been locked.
-50071	Document has been checked out.	The specified document that is to be Locked / Unlocked is checked out.
-50086	Document has expired.	The specified document that is to be Locked / Unlocked, has expired.
-50027	Properties of the Document have been finalized.	The specified document that is to be Locked / Unlocked has been finalized.
-50076	Invalid object access type.	Access Type of the specified document / folder which to be Locked / Unlocked is not valid.