This
call is used for logical deletion of documents. Single as well as multiple
documents of a folder can be deleted using this call. This call returns the
ISIndex (Image Index and Volume Index) for all documents that have been logically
deleted from the Cabinet. For deleting the document physically, DeleteDocument() function of the Image Server API should be
used after making this JTS call.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGODelete DocumentExt |
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 |
|
Documents |
Root |
A List of documents, starting from the Root is given between
<Documents> and </Documents> tags. |
|
N/A |
|
Document |
Root |
A list of information about the document is given between the
<Document> and </Document> tags. |
|
N/A |
|
DocumentIndex |
Document |
It indicates the Unique Index of the document to be deleted. |
|
N/A |
|
ParentFolderIndex |
Document |
Index of the Parent Folder of the document. |
|
N/A |
|
ReferenceFlag |
Document |
It is a flag that indicates whether to delete the documents even if
Reference exists. |
Y- Delete the documents even if Reference exists. N- Do not
delete documents if Reference exists. |
No check for References of the document is made. |
|
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. |
|
Document Size |
Root |
It indicates the
size of the document in bytes. |
|
ISIndexes |
Root |
A List of
ISIndexes, starting from the Root is given between the< ISIndexes > and
</ ISIndexes > tags. |
|
ISIndex |
ISIndexes |
Specifies a unique
Combination of Image Index and Volume Index for a document stored on the
Image Server separated by #. For example, 3#79. This can be used to delete
the document from the Image Server. |
|
Failed Documents |
Root |
A List of failed
documents, starting from the Root is given between <Failed Documents>
and </Failed Documents> tags. |
|
Failed Document |
Failed Documents |
A list of
information about the failed document is given between the <Failed
Document> and </Failed Document> tags. |
|
DocumentIndex |
Failed Document |
Unique Index of the
failed document. |
|
StatusCode |
Failed Document |
It indicates the
unique Error Code of the failed document. |
|
Code |
Message |
Comments |
|
-50074 |
Invalid Parameter. |
When we do not
specify the Document Index of the document to be deleted, then exception is
thrown. |
|
-50076 |
Invalid object
access type. |
Access Type of the
document to be deleted is improper. This error occurs while checking the
Rights on the documents. |
Warnings returned
from call
|
Code |
Message |
Comments |
|
50010 |
Not all Documents
Deleted. |
Some of the
Documents could not be deleted. |
Codes returned in the
form of status code
|
Code |
Message |
Comments |
|
-50023 |
Document not found. |
Document to be
deleted does not exist. |
|
-50170 |
Document is deleted
or moved. |
Document to be
deleted has already been moved to some other folder or deleted. |
|
-50017 |
Folder not found. |
Parent Folder of
the document to be deleted not found. |
|
-50021 |
Folder is in use. |
Some User, other
than the logged in User has locked the Parent Folder of the document to be
deleted. |
|
-50026 |
Document is in use. |
Document to be
deleted has been locked. |
|
-50071 |
Document has been
checked out. |
Document to be
deleted has been checked out. |
|
-50022 |
Insufficient rights
for the current operation. |
Document could not
be deleted as logged in User does not have Rights for deleting the document. |