User Tools

Site Tools


opac:dynamic_api

Dynamic OPAC GET parameters

(developed jointly during the LibX for Evergreen hackfest session at Access 2008)

NOTE: These instructions are also available in the Evergreen documentation at http://docs.evergreen-ils.org/1.6/draft/html/search_url.html. In github: http://github.com/rsoulliere/Evergreen-DocBook/blob/master/1.6/opac/search_URL.xml.

Template search URL: hostname/opac/en-US/skin/default/xml/rresult.xml?rt=keyword&tp=keyword&t=%2Btree%20-nickel&l=1&d=0&f=

Scope to a library hierarchy parent or child

l parameter:

  • integer-or-SHORTNAME

Search type values

rt parameter:

  • keyword
  • title
  • author
  • subject
  • series

Sorting

In the absence of s or sd parameter, it defaults to relevance

Sorting types

s parameter:

  • pubdate
  • title
  • author

Sort direction

sd parameter:

  • asc
  • desc

Advanced search (multiple fields)

Uses rt=multi; then prepend search field to the search terms (delimited by a colon) in the t parameter:

  • tp=&t=keyword%3Afools title%3Arush&av=&rt=multi

Can only search one at a time:

  • rt=isbn&adv=<ISBN>
  • rt=issn&adv=<ISSN>
opac/dynamic_api.txt · Last modified: 2010/10/20 12:44 by rsoulliere

© 2008-2017 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a member of Software Freedom Conservancy.