Issuing a Query Programmatically

Note: This documentation is for an old version of Webinator. The latest documentaion is here.

Issuing a Query Programmatically

Use the information in this section to issue a query programmatically.

You can use either POST or GET to issue the search query. The only required variables are pr (profile), query and dropXSL. Variables not specified in the query take default values.

Here is an example URL for a search.

http://HOSTNAME/texis/search/main.xml?dropXSL=0&pr=default &prox=page&rorder=500&rprox=500&rdfreq=500&rwfreq=500 &rlead=500&sufs=2&order=r&query=query

Where HOSTNAME is the IP/hostname of your Webinator, and query is the user's query.

The following table provides a description of the query variables.


Variable	Description

`pr`	Specifies the Webinator profile.
`prox`	Proximity: words should be in the same line, sentence, paragraph, or page.
`rorder`	Word order: terms same order as query are better (`0`-`1000`; `500` = medium).
`rprox`	Indicates how close the words need to be (`0`-`1000`; `500` = medium).
`rdfreq`	Importance of frequency in the table (`0`-`1000`; `500` = medium).
`rwfreq`	Importance of frequency in the document (`0`-`1000`; `500` = medium).
`rlead`	Importance of closeness to document start (`0`-`1000`; `500` = medium).
`sufs`	Word forms (suffix). `0` (exact), `1` (plurals), or `2` (any), or `3` (custom)
`order`	Controls the sort order. Values are `r` (relevance) or `d` (date).
`query`	Search query entered by site visitor.
`rpp`	Results Per Page.
`cq`	For categories. `cq=1` for 1st, `cq=2` for 2nd etc.
`tq`	Used for title-only queries.
`uq`	Used for URL Prefix queries.
`dq`	Used for depth queries.
`mtq`	Used for Mime Type queries.
`mdlt`	Modified Date less than query
`mdgt`	Modified Date greater than query
`dateSource`	What date to use, id or Modified

Table 5.2: Search Query Variables

Please see the Additional Fields section (here) for information on specifying additional field searches in the URL.