Click or drag to resize

IIQAPIDeleteDocumentById Method

Delete a document with a specific document ID from the ImageQuest system

Namespace:  Informa.ImageQuest.API.Library
Assembly:  Informa.ImageQuest.API.Library (in Informa.ImageQuest.API.Library.dll) Version: 14.3.0.0
Syntax
void DeleteDocumentById(
	string token,
	Guid documentId,
	string reason
)

Parameters

token
Type: SystemString
User Authentication Token from a previous Login(String, String, String) or SystemLogin(String) call.
documentId
Type: SystemGuid
Document Identifier for an existing ImageQuest document to be deleted.
reason
Type: SystemString
Reason or justification for deleting this document.
Remarks

Documents deleted through the ImageQuest API are marked as such by setting the Deleted attribute to "True" on the specified document. These documents are still present in the ImageQuest system, and can still be accessed (both via the API and by client applications) by users with the appropriate permissions to do so.

To permanently remove a document from the ImageQuest system, after deleting the document via DeleteDocument(String, IQDocument, String), you must use the ImageQuest Administrator to purge the deleted documents.

See Also