Ready to Learn?Ex Libris products all provide open APIs

General Purpose

Provides access to the Find Databases light box on your Primo server.

This functionality is true to any Primo page, meaning if you add to the URL the following: &openFdb=true, the Find Databases lightbox will appear and the original Primo page will be displayed behind.

NOTE: There is no option to open the Find Databases screen not as a lightbox (a Primo page will always exist behind it).

 

Input Parameters

NameExplanationMandatory
openFdbThe flag that enables the functionality. Set to true to enable the functionality.Yes
prefLangDefine the UI language, the purpose is to display the Primo front end in the requested interface language parameter Need to be set with the requested local for example: prefLang = en_USNo
searchTypeEnter one of the following values:
AZ – for AZ search
Find – for any other search
No (default is AZ)
searchMethodWorks only if searchTerm exists. Enter one of the following search methods: CONTAINS, EXACT, or BEGINS_WITH.No (default is CONTAINS)
searchTermFor searchType=AZ, specify the letter that the database names begin with (A-Z or other).
For searchType=Find, enter the name of the database (which is similar to the ‘name’ field)
For AZ search: No (default is A)

For Find search: Yes
publisherOnly relevant for searchType=Find. Specify the database’s publisher (as defined in the MetaLib IRD).No
keywordsOnly relevant for searchType=Find. Specify the database’s keywords(as defined in the MetaLib IRD).No
irdTypeOnly relevant for searchType=Find. Specify the database type (as defined in the MetaLib IRD).No
categoryOnly relevant for searchType=Find. Specify the name of the category (as defined in MetaLib).No
subCategoryOnly relevant for searchType=Find. Specify the name of one of the subcategories for the category described above. You must specify a subcategory if you choose to search by category. It is not possible to combine a category/subcategory search with other searches.No
includeRestrictedSpecify one of the following values:
0 : don’t show ‘No access’ databases
1 : show ‘No access’ databases
No (default is 1)
rememberMeAfter selecting databases in the Find Databases light box and exiting, the system will show the same selected databases if opened in the same session. This parameter provides the same behavior for deep links. The following values are valid:
true – show selected databases if there are any
false – do not show selected databases if there are any)
No (default is false)

 

Notes

  1. Search parameters that contain non-English letters may not return expected results when using the IE browser.
    To prevent unexpected results, you should percent-encode the letters in a URI.
     
  2. The openFdb parameter can be added to any of the deep link URLs (This is also true to any non deep link Primo URL).

 

Input Example

http://<host>:<port>/primo_library/libweb/action/search.do?vid=Auto1&openFdb=true&searchType=Find&searchTerm=health&searchMethod=CONTAINS

 

Output Example