Click or drag to resize

IIQAPI Interface
Interface to the ImageQuest Web Services API.

Namespace:  Informa.ImageQuest.API.Library
Assembly:  Informa.ImageQuest.API.Library (in Informa.ImageQuest.API.Library.dll) Version: 14.3.0.0
Syntax
Copy
public interface IIQAPI

The IIQAPI type exposes the following members.

Methods
  NameDescription
Public methodAddNote
Add a note to a specific document.
Public methodAddRevision
Add a revision to the IQDocument object identified by the specified GUID.
Public methodCode exampleCreateDocument
Create a new document in ImageQuest with the specified index values and associated backing document.
Public methodDeleteDocument
Delete a document from the ImageQuest system.
Public methodDeleteDocumentById
Delete a document with a specific document ID from the ImageQuest system
Public methodGetAttributes
Retrieve the list of all valid attributes for the current cabinet.
Public methodGetDocument
Retrieve a single document from the ImageQuest system based on the document's unique identifier.
Public methodCode exampleGetDocumentStream
Retrieve the backing file data associated with a specified ImageQuest document
Public methodGetDocumentTypeAttributes
Return a list of attributed that are associated with the given document type.
Public methodGetDocumentTypes
Retrieve a list of defined document type schema definition names
Public methodGetListAttributeItems
Return a list of legal values for a particular IQ List Attribute
Public methodLogin
Log in to an ImageQuest cabinet as the specified ImageQuest user
Public methodRouteDocToRole
Route a document to a specific Role.
Public methodRouteDocToUser
Route a document to a specific User.
Public methodCode exampleSearch
Execute an ad-hoc ImageQuest query to return a desired set of ImageQuest documents.
Public methodSSOLogin
Log in to an ImageQuest cabinet using SSO
Public methodSystemLogin
Log in to an ImageQuest cabinet as a system-level process.
Public methodCode exampleUpdateDocument
Post changes to an existing IQDocument object into the ImageQuest system.
Public methodValidateAttribute
Performs data validation on a proposed value for an ImageQuest attribute.
Top
Remarks

This interface defines the interactions between the ImageQuest core system and API consumer applications. Applications using .NET 3.5 or higher, and the new WCF-based Service References, should use this interface via the Service Proxy to interact with the ImageQuest system.

Examples
Copy
using ( IIQAPI api = new ImageQuestService.IQAPIClient() )
{
    string token = api.SystemLogin("ImageQuest");
    IQDocumentAttribute[] metadata = new[] 
    {
        new IQDocumentAttribute { Name = "DocumentType", Value = "Invoice" },
        new IQDocumentAttribute { Name = "InvoiceNumber", Value = "12345" },
        new IQDocumentAttribute { Name = "CustomerNumber", Value = "105-B" },
        new IQDocumentAttribute { Name = "PageCount", Value = "15" },
        new IQDocumentAttribute { Name = "NeedsOCR", Value = "True" },
    };
    byte[] data = File.ReadAllBytes(scannedImage);

    // Add the new document into ImageQuest.
    IQDocument document = api.CreateDocument(token, metadata, scannedImage, data);
    api.AddNote(token, document.Id, "Customer invoice scanned into ImageQuest via API.");

    // Retrive the new document via IQQL and make it a purchase order.
    IQDocument[] documents = api.Search(token, "[CustomerNumber] = '105-B'", String.Empty);
    foreach ( IQDocumentAttribute attribute in documents[0].Metadata )
    {
        if ( attribute.Name == "DocumentType" )
        {
            attribute.Value = "PurchaseOrder";
        }
    }
    api.UpdateDocument(token, documents[0]);
}
See Also