SRU VERSION 1.1 ARCHIVEScan OperationRequest Parameters - Response Parameters - Term Parameters - Examples While the searchRetrieve operation enables searches for a specific term within a list of indexed terms from the records, the scan operation allows the client to request a range of the available terms at a given point within that list. This enables clients to present an ordered list of values and, if supported, how many hits there would be for a search on that term. Scan is often used to select terms for subsequent searching or to verify visually a negative search result. The index to be browsed and the start point within it is given in the scanClause parameter as a complete index, relation, term clause in CQL. The relation and relation modifiers may be used to determine the format of the terms returned. For example 'dc.title any fish' will return a list of keywords, whereas 'dc.title exact fish' would return a list of full title fields. Range relations, such as <, >=, within and so forth, are prohibited for use with scan, and diagnostic 'info:srw/diagnostic/1/19' should be returned. See below for a clarifying example. The term given in the clause is the position within the ordered list of terms at which to start, however see the responsePosition parameter below for more information. If the empty term is given, then even if searching for it is unsupported by the server, it may be interpreted as the beginning of the term list.
Scan Request Parameters
Scan Response Parameters
Sub Parameters for Term
ExamplesA typical scan request might be: http://myserver.com/myurl/?operation=scan&version=1.1 The response would be of the form: <?xml-stylesheet type=text/xsl" href="http:myserver.com/myStyle"?> <srw:scanResponse xmlns:srw="http://www.loc.gov/zing/srw/" xmlns:diag="http://www.loc.gov/zing/srw/diagnostic/" xmlns:myServer="http://myServer.com/"> <srw:version>1.1</srw:version> <srw:terms> <srw:term> <srw:value>CARTESIAN 4456345</srw:value> <srw:numberOfRecords>35645</srw:numberOfRecords> <srw:displayTerm>Carthesian</srw:displayTerm> <srw:extraTermData> <myserver:ID>4456345</myserver:ID> </srw:extraTermData> </srw:term> <srw:term> <srw:value>CARTESIAN 4456376</srw:value> <srw:numberOfRecords>2154</srw:numberOfRecords> <srw:displayTerm>Carthésian</srw:displayTerm> <srw:extraTermData> <myServer:ID>4456376</myServer:ID> </srw:extraTermData> </srw:term> <srw:term> <srw:value>CAT 4456392</srw:value> <srw:numberOfRecords>8739972</srw:numberOfRecords> <srw:displayTerm>Cat</srw:displayTerm> <srw:extraTermData> <myserver:ID>4456392</myserver:ID> </srw:extraTermData> </srw:term> <srw:term> <srw:value>CATHOLIC DOGMA 4456888</srw:value> <srw:numberOfRecords>35</srw:numberOfRecords> <srw:displayTerm>Catholic Dogma</srw:displayTerm> <whereInList>last</whereInList> <srw:extraTermData> <myserver:ID>4456888</myserver:ID> </srw:extraTermData> </srw:term> </srw:terms> <srw:extraResponseData> <rob:authenticationToken xmlns:rob="info:srw/extension/2/auth-1.0"> XDFPQR5ZZ </rob:authenticationToken> </srw:extraResponseData> <srw:echoedScanRequest> <srw:version>1.1</srw:version> <srw:scanClause>dc.title="cat"</srw:scanClause> <srw:responsePosition>3</srw:responsePosition> <srw:maximumTerms>3</srw:maximumTerms> <srw:stylesheet>http://myserver.com/myStyle</srw:stylesheet> </srw:echoedScanRequest> </srw:scanResponse> |
July 25, 2007 |