Ticket #515 (closed task: fixed)
[M] Discovery WS back-end methods specification
Reported by: | selatham | Owned by: | mpritcha |
---|---|---|---|
Priority: | critical | Milestone: | ReFactored_Discovery_WebServices |
Component: | discovery | Version: | |
Keywords: | Cc: |
Description
Start a document stating the methods available for the Discovery WS. Pass to ndg list for comment. (This could become the basis for formal documentation for the Discovery product).
Change History
comment:3 Changed 14 years ago by lawrence
... probably need a method to formally drop a result set ...
comment:4 Changed 14 years ago by mpritcha
Just noticed something important in the exist XMLRPC interface. The hit count returned in querySummary() is actually the number of hits in the result set, not the number of distinct documents in the result set (Imagine a result set where document 1 matched 20 times, document 2 matched 5 times. 25 "hits", 2 documents).
I presume we're only interested in the latter, for the purposes of paging through results?
Proposed methods are as follows:
There will probably also be method(s) for fetching n results from a particular result set, but I intend to get the above working first.
Each of doFullTextSearch, doParameterSearch, doAuthorSearch will have its own XQuery defined somewhere, possibly with variants for coping with different collections (i.e. documents from different schemae DIF / EDMED? / ISO etc)
There will be an XML schema (available via the WSDL) defining the request and response message structure for each of the above methods (to follow).