This call is used to get the list of Versions of a document. User can also specify the version from where the retrieval of Version List has to be started.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOGet VersionList |
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 NGOConnectCabinet call. |
|
N/A |
|
DocumentIndex |
Root |
The Document Index corresponding to which the Versions have to be retrieved. |
Integer
> |
N/A |
|
StartVersion |
Root |
The last Version Number received in previous batch. |
X. Y where X>=1 and Y>=0 |
1.0 |
|
NoOfRecordsTo Fetch |
Root |
Number of records to be fetched for this batch. |
Integer >0 |
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. |
|
NoOfRecordsFetched |
Root |
Number of Versions fetched. |
|
TotalNoOfRecords |
Root |
In case of batches, if this value is one greater than NoOfRecordsFetched, then it means that the there are more versions to be fetched. |
|
CheckoutStatus |
Root |
Indicates whether the document is checked out or not. |
|
Versions |
Root |
Contains information about the fetched Versions. |
|
Version |
Versions |
Contains information about a particular Version. |
|
DocumentIndex |
Version |
The Document Index of the document whose Version List has been retrieved. |
|
ParentFolderIndex |
Version |
The Folder Index of the Parent Folder of the document. |
|
VersionNo |
Version |
Version Number of the document. |
|
VersionComment |
Version |
Comment associated with this version. |
|
CreationDateTime |
Version |
The Date and Time at which the document was created. |
|
Name |
Version |
Name of the document. |
|
Owner |
Version |
The name of the Owner of the document. |
|
CreatedByUser |
Version |
Name of the User who created the document. |
|
ISIndex |
Version |
The Image and Volume Index of a particular Version of the document on the Image Server. |
|
DocumentSize |
Version |
The size (in bytes) of a particular Version of the document. |
|
NoOfPages |
Version |
Number of pages of a particular Version of the document. |
|
LockFlag |
Version |
Indicates whether this document version is locked or not. |
|
LockByUser |
Version |
Name of the user by whom the document version has been locked. |
|
CreatedByAppName |
Version |
The extension of a particular Version of the document. |
|
FTSFlag |
Version |
Reserved for internal use. |
|
PullPrintFlag |
Version |
PullPrint flag associated with the document. Its valid values are: Y – pullprint generated P – Pending F – Failed I – Insoview generated |
|
DocumentType |
Version |
Type of a particular Version of the document. ‘I’ – Image, ‘N’ – Non image |
|
Code |
Message |
Comments |
|
-50023 |
Document not found. |
Document with the specified Document Index does not exist. |
|
-50132 |
Document has been deleted. |
The specified document has been deleted. |
|
-50053 |
Check rights failed. |
Could not retrieve the Rights for the specified User. |
|
-50022 |
Insufficient rights for the current operation. |
The User trying to retrieve the Versions of the document does not have sufficient Rights on the document. User must have Read Rights on the document whose Version has to be fetched. |