NGODeleteFolder

This call is used to delete an existing folder permanently from the system. If shortcut for the documents in Folders or its sub folders exists, then the Reference Flag can be used to avoid deletion of folder. Similarly, if some documents in Folder or its subfolders are either Locked or Checked Out, then LockFlag and CheckOutFlag can also be used to avoid deletion of the folder. While the documents of the folder are deleted, the subfolders with its documents will also be deleted. This call will logically delete the documents.

This call returns the ISIndex (Image Index and Volume Index) for all documents that have been successfully and logically deleted from the Cabinet. Using the ISIndex, the documents can also be deleted physically using the function DeleteDocument() of the Image Server API.

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.	NGODelete Folder	N/A
CabinetName	Root	Name of the Cabinet to which the User wants to connect.		N/A
UserDBId	Root	UserDatabase ID, which is returned in the NGOConnectCabinet call.		N/A
FolderIndex	Root	Index of the Folder that is to be deleted.		N/A
ParentFolderIndex	Root	Index of the Parent Folder of the folder, which is to be deleted
ReferenceFlag	Root	It specifies whether to delete the folder, when the references exist for the documents within that folder or any of its subfolders.	N – Don’t delete folder if any reference for some document within that folder or any of its subfolders exists. Y – Delete folder even if reference exists for some document within that folder or any of its subfolders.	‘N’
LockFlag	Root	It specifies whether to delete the folder, when any document within that folder or any of its subfolders is locked.	N – Don’t delete folder if any document exists within that folder or its subfolders that is locked. Y – Delete folder even if any document exists within that folder or its subfolders that is locked.
CheckOutFlag	Root	It specifies whether to delete the folder, when some checked out document exist within the folder or any of its subfolders.	N – Don’t delete folder if any checked out document exists within that folder or any of its subfolders. Y – Delete folder even if any checked out document exists within that folder or any of its subfolders.	‘N’
LogGeneration	Root	Flag, which specifies whether the log is to be generated or not.	Y – log is generated. N – No log is generated.	Y
RightsFlag	Root	Not in use now.		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.
ReferenceFlag	Root	This flag can be used to find out why the folder is not deleted. Folder is not deleted because some of the documents are referenced in the folder or any of its subfolders. If ReferenceFlag is sent as ‘N’ in input xml and if it returns the value ‘Y’, it shows that folder is not deleted because some of the documents in the folder or its subfolder are referenced.
LockFlag	Root	This flag is used to reason out why the folder is not deleted. Folder is not deleted because some of the documents in the folder or its sub folder are Locked. If LockFlag is sent as ‘N’ in input xml and if it returns the value ‘Y’, it shows that the folder is not deleted because some of the documents in the folder or its subfolder are locked.
CheckOutFlag	Root	This flag can be used to find out why the folder is not deleted. Folder is not deleted because some of the documents are checked out in the folder or any of its subfolders. If CheckOutFlag is sent as ‘N’ in input xml and if it returns the value ‘Y’, it shows that folder is not deleted because some of the documents in the folder or its subfolder are checked out.
NoOfDeletedDocuments	Root	Total number of documents that are to be deleted.
TotalDocumentSize	Root	Specifies the total size of all the documents together in the folder or its subfolders that is to be deleted.
ISIndexes	Root	List of ISIndexes for the deleted Document.
ISIndex	ISIndexes	Specifies a # separated unique combination of Image Index and Volume Index for the document in the folder. This is used to delete document from the Image Server.

Errors returned from call

Code	Message	Comments
-50017	Folder not found.	The folder that was to be deleted does not exists.
-50171	Folder is deleted or moved.	The folder that was to be deleted has been either deleted or moved from its location.
-50021	Folder is in use.	Folder to be deleted has been locked by some User other than the logged in User.
-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.
-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.
-50076	Invalid object access type.	Some subfolder of the folder to be deleted or the folder itself has improper access type.This error occurs in the process of rights checking on the folders.