Interrogate

NOTE: Enth Internal, KEY must contains Enth Administrator privileges.

Interrogate is very similar to Search. Based on the REQUEST, the subscription level associated with the KEY, Interrogate asks Enth to perform a Search across the Enth Network. Results are sorted by a scored algorithm. Results can be XML, JSON or formatted HTML. If HTML is specified, a Real Simple Syndication (RSS) feed is return which contains the search results. If the search is unsuccessful, a message containing the reason why a result wasn't found.

If CONTEXT is true, Enth generates additional requests similar to the original REQUEST. The additional requests can be used to provide 'context' to the original REQUEST.

The key difference between Search and Interrogate is that Interrogate operate asynchronously, providing a Transaction ID after the initial call to INTERROGATE. Using the Transaction ID in subsequent calls to Interrogate provides additional information about the process, until the final results are generated. Once the results are generated the response from Interrogate is identical to Search.

INTERROGATE is an internal diagnositc tool.


Methods

   POST


Consumes

   application/x-www-form-urlencoded


Produces

   application/json    application/XML (deprecated)    text/html (deprecated)


Returns

    A json string contains information regarding the progress of this request. When complete INTERROGATE returns the normal SEARCH response.


Parameters

Parameter Data Type Required Administrator Description
KEY String Required Administrator A valid Enth Key (refer to Login). Must be an Administrator.
REQUEST String Administrator The search request in the form of a word, words, question, or sentence.
ID String Administrator The Transaction ID for Request.
NETWORK Boolean Administrator If NETWORK is TRUE, Enth collects the Enth Network configuration.
CONTEXT Boolean Administrator If CONTEXT is TRUE, Enth generates additional requests similar to the original REQUEST. The additional requests can be used to provide 'context' to the original REQUEST.
LONGITUDE Double Administrator A valid Longitude, typically generated from the requesting device.
LATITUDE Double Administrator A valid Latitude, typically generated from the requesting device.
SOURCE String Administrator The name or type of requesting source or device.

Also See:   Login    Search

Code Example

   https://YourEnthAppliance/EnthAPI/search/interrogate