This call is used to perform CheckIn and CheckOut operations on the selected document. Operation that is to be performed is specified by the checkinCheckoutFlag. User can also set information about the carry forwarding of annotations when new Version is created. When a User CheckIns a document with a new Version, first a document is added to the Image Server and then the operation is performed. User has to specify the Image Index and Volume Index returned from the Image Server.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOCheckin CheckoutExt |
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 |
Maximum number of Versions that can be created for the document used only for CheckIn operation. |
Integer >= 0 |
NULL |
|
CheckInOutFlag |
Root |
Specifies the desired type of operation. For example, 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’ |
|
Documents |
Root |
Contains information about the documents being checked out/checked in. |
|
|
|
Document |
Documents |
Contains information about the document being checked out/checked in. |
|
|
|
DocumentIndex |
Document |
Document Index of the document being checked out/checked in. |
Integer >=0 |
N/A |
|
VersionComment |
Document |
Comments for new Version of the document. This is used only for CheckIn operation. |
Text |
NULL |
|
DocumentType |
Document |
Type of document being checked out/checked in This is used only for CheckIn operation. |
‘I’ – Image ‘N’ – Non Image |
N/A |
|
ISIndex |
Document |
Specifies a unique Combination of Image Index and Volume Index for a document added to the Image Server before making this call. Its format is Image Index and Volume Index separated by #. For example, 3#79. It is used for CheckIn operation only. |
|
|
|
NoOfPages |
Document |
Number of pages in the document being checked in. This is used only for CheckIn operation. |
Integer >= 1 |
N/A |
|
DocumentSize |
Document |
Size (in bytes) of the document being checked in. This is used only for CheckIn operation. |
Integer > 0 |
N/A |
|
CreatedByAppName |
Document |
Extension of document being checked out/checked in. This is used only for CheckIn operation. |
Extension of the document. |
N/A |
|
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. |
|
Documents |
Root |
Contains information about all the documents that have been checked out/ checked in. |
|
Document |
Documents |
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 document that is being checked out/checked in. (Current Version) |
|
NoOfPages |
Document |
The total number of pages in the document. |
|
DocumentName |
Document |
Name of the document. |
|
OwnerIndex |
Document |
The Index of the Owner of the document. |
|
CreationDateTime |
Document |
The Date and Time on which the document was created. |
|
RevisedDateTime |
Document |
The Date and Time on 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. |
|
VersionFlag |
Document |
Signifies whether the Versions of the document exist or not. ‘Y’ – Yes ‘N’ – No |
|
AccessType |
Document |
The Access Type on the document. ‘P’ – Private, ‘S’ – Shared, ‘I’ – Inherited |
|
DocumentType |
Document |
The Type of the document being checked out/checked in. ‘I’ – Image, ‘N’ – Non image |
|
CreatedByApp |
Document |
Reserved for internal use. |
|
CreatedByAppName |
Document |
The extension of the document being checked out/checked in. |
|
ISIndex |
Document |
The Image and Volume Index of the checked out/checked in document on the Image Server. |
|
TextISIndex |
Document |
Reserved for internal use. |
|
DocumentSize |
Document |
The size (in bytes) of the document being checked out/checked in. |
|
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 |
|
FinalizedDateTime |
Document |
The Date and Time on which the document was finalized/ checkedin. |
|
ACL |
Document |
String comprising the Rights of Users / Groups on the current document. |
|
ACLMoreFlag |
Document |
Reserved for internal use. |
|
ThumbNailFlag |
Document |
Indicates whether thumbnail generation is complete or not. ‘N’ – No, ‘Y’ – Yes |
|
CheckoutStatus |
Document |
Indicates whether the document has been checked out or not. ‘N’ – No, ‘Y’ – Yes |
|
DataDefIndex |
Document |
The index of the Data Definition associated with the document. |
|
FailedDocuments |
Root |
Contains the information about the documents that could not be checked out/checked in. |
|
FailedDocument |
Failed Documents |
Contains information about the document that could not be checked out/checked in. |
|
DocumentIndex |
Failed Document |
Document Index of the document that could not be checked out/checked in. |
|
Status |
Failed Document |
Contains the Error code that is returned when the move operation on the document failed. |
|
Code |
Message |
Comments |
|
-50074 |
Invalid parameters. |
Some of the parameters entered were incorrect. This exception occurs when no document is specified in the input on which CheckIn / CheckOut operation is to be performed. |
Warnings returned from call
|
Code |
Message |
Comments |
|
50011 |
Not all documents checked out. |
Some of the documents could not be checked out. |
|
50012 |
Not all documents checked in. |
Some of the documents could not be checked in. |
|
50013 |
Not all documents undo checked out. |
Undo CheckOut operation could not be performed on some of the documents. |
Codes returned in the form of status code
|
Code |
Message |
Comments |
|
-50023 |
Document not found. |
Document on which the operation is to be performed does not exist. |
|
-50132 |
Document has been deleted. |
Document on which the operation is to be performed has been deleted. |
|
-50071 |
Document has been checked out. |
CheckIn or Undo CheckOut operation on the document failed as some User other than the logged in User has checked out the document. |
|
-50086 |
Document has expired. |
Document on which the User wants to perform the CheckOut / CheckIn operation has expired. |
|
-50027 |
Properties of the Document have been finalized. |
Properties of the Document on which the User wants to perform CheckOut / CheckIn operation has been finalized. |
|
-50026 |
Document is in use. |
Document has been locked for some purpose. |
|
-50022 |
Insufficient rights for the current operation. |
Logged in User does not have sufficient Rights. User must have Read Rights on the document. |
|
-50158 |
Document is already checked out. |
Document could not be checked out as it has already been checked out. |
|
-50159 |
Document is not checked out. |
Document could not be checked in as it has not been checked out. |
|
-50174 |
Limit on number of Versions exceeded. |
Data Class for which the User wants to get the Rights does not exist in the System. |
|
-50053 |
Check rights failed. |
Check Rights operation failed internally. |