Ready to Learn?Ex Libris products all provide open APIs

Browse Primo Records

General Purpose

The browse request performs a browse (by a selected field) action on the repository records

Current Known Issues (Version 4.1.0):

1. The browse results section contains record Id's linked to the specified term, the list includes records from all of the indexed institutions.

2. When using the service to retrieve terms with type the sort does not work properly.

3. The service retrieves an incorrect number of results.

4. Validation checks for input parameters are missing ( bulk > 50, browseField doesnt exist ...)

Product Version Compatibility

Version 4.1.0 and later

Input Parameters Description

The first four parameters in the list below are only relevant for restricted scopes. A restricted scope is authorized according to the following parameters: institution, group, and onCampus. Because the institution parameter defines which PC key is sent to Primo Central, it is most important when searching in Primo Central.

Input Parameters

ParameterDescriptionMandatory
institutionThe institution code. The institution which should be browsedYes
browseFieldThe browsed field.
Possible values are:
browse_author -- Author
browse_title -- Title
browse_subject -- Subject
browse_callnumber -- Call Number
browse_callnumber.0 -- Library of Congress Call Number
browse_callnumber.1 -- Dewey Call Number
browse_callnumber.3 -- SUDOC Call Number
Yes
searchTxt(freeText0) The Browse termYes
numOfRecordsNumber of entries to present in the responseYes  

Output Parameters

ElementDescriptionValue
browseSearchObjectRoot element of the XML tree.no value
backTermThe term to use to get the previous entriestext
nextPresentedValuesElement to contain one or several subelements.
 
no value
nextTermThe next termtext
primoTermElement to contain one or several subelements.
Structure: Subelement of nextPresentedValues.
no value
displayValueElement to contain one or several subelements.
Structure: Subelement of primoTerm
Includes a key/value pair (entry):
key -- The display value
value -- The indexed value 
entry(key/value) 
docFreqStructure: Subelement of primoTerm.
The counter representing the amount of entries related to the term
Number
docIdsStructure: Subelement of primoTerm.
 Record Id's related to the entry
text
indexTextValue Structure: Subelement of primoTerm.
 The indexed value 
text 
typeThe entry Typetext

Input Example

http://primo.com:170X/PrimoWebServices/xservice/browsesearch/search?institution=01BC_INST&browseField=browse_subject&numOfRecords=10&searchTxt(freeText0)=home

Output Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<browseSearchObject>
    <backTerm>
        hiratsuka haru 1886 1971LCNAMES
    </backTerm>
    <lastPnxIndex>
        -1
    </lastPnxIndex>
    <nextPresentedValues>
        <primoTerm>
            <displayValue>
                <entry>
                    <key>
                        History -- Africa -- Statistics
                    </key>
                    <value>
                        history africa statistics
                    </value>
                </entry>
            </displayValue>
            <docFreq>
                1
            </docFreq>
            <docIds>
                primo_alma21347976120001021
            </docIds>
            <indexTextValue>
                history africa statistics
            </indexTextValue>
        </primoTerm>
        <primoTerm>
            <displayValue>
                <entry>
                    <key>
                        History, Ancient -- Sources -- Sources
                    </key>
                    <value>
                        history ancient sources sources
                    </value>
                </entry>
            </displayValue>
            <docFreq>
                1
            </docFreq>
            <docIds>
                primo_alma21340335090001021
            </docIds>
            <indexTextValue>
                history ancient sources sources
            </indexTextValue>
        </primoTerm>
    </nextPresentedValues>
    <nextTerm>
        history generalbisacsh
    </nextTerm>
    <numOfUsefTerms>
        -1
    </numOfUsefTerms>
</browseSearchObject>