Mirlynapi:searchInfo

From MLibrary API

Jump to: navigation, search

MirlynAPI "searchInfo"

Every successful search in the Mirlyn API returns, along with the requested data, a section call searchInfo that shows information about the search you just performed. A sample looks in JSON format looks like: 

"searchInfo" : {
  "catalogLink" : "http://mirlyn.lib.umich.edu/F/?func=find-c&ccl_term=WAU%3D(Ottaviani)",
  "query" : "WAU=(Ottaviani)",
  "recordsRequested" : "1-3",
  "requestURI" : "http://mirlyn.lib.umich.edu/cgi-bin/api/circstatus.json/author/Ottaviani",
  "sethint" : "wau|Ottaviani|year_down",
  "sortorder" : "year_down",
  "totalResults" : 28
}

The data are:

  • catalogLink A link that will perform the identical search in Mirlyn's web-based OPAC.
  • query The actual query that was run, in CCL.
  • recordsRequested Which records were requested
  • requestURI The URI that was actually sent to the API script
  • sethint A quasi-unique identifier for the search, currently unused. In the future, code will be added that will use the sethint to avoid repeated searches when unnecessary.
  • setorder Currently, always year_down. User-supplied sort order is coming in the future.
  • totalResults The total results available in the record set (although, keep in mind you can only get 30 at a pop). This number maxes out at 5000 due to the way searches are done in the underlying system.
Retrieved from "http://webservices.itcs.umich.edu/mediawiki/MLibraryAPI/index.php/Mirlynapi:searchInfo"
Personal tools