NGOCheckInCheckOut

This call provides the CheckIn and CheckOut functionalities for the document. User who has checked out the document can alone modify the Document Property. Other Users can modify the Document Property after the document has been checked in. To create a new Version for the checked in document, User has to add the document to the Image Server and make this call by providing the Image Index and the Volume Index returned by the Image Server.

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.	NGOCheckIn Checkout	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, which is returned in the NGOConnect Cabinet call.		N/A
CurrentDateTime	Root	The Date and Time at which the documents are being checked out/checked in.	Valid Date in the format- yyyy-mm-dd hh:mm:ss	The current Date and Time.
LimitCount	Root	This is applicable only in case of CheckIn operation. This is the count beyond which Versions for the document cannot be made. If a value specified in LimitCount is lesser than the Number of Versions of the document, then error will occur.	Integer >= 0	NULL
CheckInOutFlag	Root	Specifies the desired type of operation viz. CheckIn, CheckOut and undo CheckOut.	‘N’ - CheckIn ‘Y’ – CheckOut ‘U’ – undo	N/A
SupAnnotVersion	Root	Specifies whether the Annotations on the previous Version are to be suppressed or not.	‘Y’ – Yes ‘N’ – No	‘N’
DocumentIndex	Root	Document Index of the document being checked out / checked in.	Integer >=0	N/A
ISIndex	Root	Specifies a unique Combination of Image Index and Volume Index for a document stored on Image Server separated by #. Example, 3#79. It is used for CheckIn operation only.
VersionComment	Root	Comments added while checking out / checking in the document.	Text	NULL
DocumentType	Root	Type of the checked out/checked in document. (Not required for CheckOut operation).	‘I’ – Image ‘N’ – Non Image	N/A
NoOfPages	Root	Number of pages in the document being checked out / checked in. (Not required for CheckOut operation).	Integer >= 1	N/A
DocumentSize	Root	Size (in bytes) of the checked out / checked in document. (Not required for CheckOut operation).	Integer > 0	N/A
CreatedByApp Name	Root	Extension of the checked out/checked in document. (Not required for check out operation).	Extension of 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. Status of the call. If the Status is 0, then the call is successful.
Document	DocumentsRoot	Contains information about the document that has been checked out / checked in.
DocumentIndex	Document	The Document Index of the document that has been checked out / checked in.
ParentFolderIndex	Document	The Folder Index of the Parent Folder of the document.
DocumentVersionNo	Document	The Version Number of the checked out / checked in document. (Current Version)
NoOfPages	Document	The total number of pages in the document.
DocumentName	Document	Name of the document.
Owner	Document	Name of the Owner of the document.
OwnerIndex	Document	The Index of the Owner of the document.
CreationDateTime	Document	The Date and Time at which the document was created.
RevisedDateTime	Document	The Date and Time at which the Properties of the document were last changed.
AccessDateTime	Document	The Date and Time at which the document was last accessed.
ExpiryDateTime	Document	The Date and Time at which the document will expire.
DataDefIndex	Document	Index of the data class that is associated with the specified document.
VersionFlag	Document	Signifies whether the Versions of the document exist or not. ‘Y’ – Yes ‘N’ – No
AccessType	Document	Type of Access on the document. ‘P’ – Private, ‘S’ – Shared, ‘I’ – Inherited
DocumentType	Document	Type of checked out / checked in document. ‘I’ – Image, ‘N’ – Non image
CreatedByApp	Document	Reserved for internal use.
CreatedByAppName	Document	The extension of the checked out / checked in document.
ISIndex	Document	The Image and Volume Index of the checked out / checked in document on the Image Server.
DocumentSize	Document	The size (in bytes) of the checked out / checked in document.
DocOrderNo	Document	The order in which the checked out / checked in document was added to the folder.
FTSDocumentIndex	Document	Reserved for internal use.
ODMADocumentIndex	Document	Reserved for internal use.
EnableLog	Document	Whether Log should be maintained for CheckIn / CheckOut operation on the document. ‘N’ – No, ‘Y’ – Yes
DocumentLock	Document	Whether the document has been locked or not. ‘N’ – No, ‘Y’ – Yes.
Comment	Document	Comments that were added while adding the document or changing the Document Property.
Author	Document	Author of the document.
FTSFlag	Document	Reserved for internal use.
DocStatus	Document	The Status of the document. ‘A’ – Added, ‘R’ – Read
FinalizedFlag	Document	Whether the document has been finalized or not. ‘N’ – No, ‘Y’ – Yes
FinalizedBy	Document	The name of the User who finalized the document.
FinalizedDateTime	Document	Date and Time when the document was finalized.
CheckOutStatus	Document	Indicates whether the document has been checked out or not. ‘N’ – No, ‘Y’ – Yes
ACL	Document	String comprising the Rights of Users / Groups on the current document.
ACLMoreFlag	Document	Reserved for internal use.
CheckOutBy	Document	Index of the User who has checked out the document
ThumbNailFlag	Document	Indicates whether thumbnail generation is complete or not. ‘N’ – No, ‘Y’ – Yes
LockByUser	Document	Name of the user who has locked the document.

Errors returned from call

Code	Message	Comments
-50071	Document has been checked out.	When the User wants to check in the document that is checked out by some other User.
-50086	Document Has Expired.	When the document being checked in / checked out has expired.
-50027	Properties of the Document has been finalised.	When the document being checked in / checked out is finalized.
-50026	Document is in use.	When the document being checked in / checked out is locked.
-50157	Document Not Checked Out	User wants to Check In a document that is not checked out.
-50158	Document Already Checked Out	When the User wants to CheckOut a document that is already checked out.
-50132	Document Has Been Deleted	When the document being checked in / checked out has been deleted.
-50023	Document not found.	Document on which CheckIn / CheckOut operation is to be performed does not exists.
-50022	Insufficient rights for the current operation.	User does not have Rights on the document. User must have Read Rights on the document.
-50174	Limit on number of Versions exceeded.	Data Class, for which the User wants to get Rights, does not exist in the System.
-50053	Check rights failed.	Check Rights operation failed internally.