Ready to Learn?Ex Libris products all provide open APIs

Maximum Topics Parameter

Syntax

The query expansion parameter uses the following syntax:

s.rec.topic.max=<integer>

A query string may contain only one s.rec.topic.max parameter. The default value for this parameter is 0.

Function

The maximum topics parameter defines the maximum number of topics that will be returned in the search result. Currently, this parameter only supports 0 or 1 as input.

The response will contain the following items:

  • Encyclopedia resource 
  • Suggested librarian 
  • Recommended topics
  • Recommended research guides

Example - Using the s.rec.topic.max parameter

This query string enables the topic service to return a maximum of 1 topic for the search:

s.q=heart+attack&s.rec.topic.max=1

Response

The following is an example topic recommendations response section:

 "topicRecommendations": [
        {
            "title": "Music",
            "snippet": "Music is an art form whose medium is sound and silence. Its common elements are pitch (which governs melody and harmony), rhythm (and its associated concepts tempo, meter, and articulation), dynamics, and the sonic qualities of timbre and texture.",
            "score": 4.955859,
            "sourceName": "wikipedia",
            "sourceLink": "http://example.summon.serialssolutions.com/2.0.0/link/topicrec/AAA...,
            "relevantAuthors": [],
            "relatedTopics": [
                {
                    "topicId": "Folk_music-en",
                    "title": "Folk music"
                },
                {
                    "topicId": "Soul_music-en",
                    "title": "Soul music"
                },
                {
                    "topicId": "Native_American_music-en",
                    "title": "Native American music"
                }
            ],
            "researchGuides": [
                {
                    "title": "Browse Databases by Subject. Recommended Databases for Music. Recommended Databases",
                    "link": "http://example.summon.serialssolutions.com/2.0.0/link/topicrec/AAA...",
                    "author": "Laura Williams"
                },
                {
                    "title": "Music",
                    "link": "http://example.summon.serialssolutions.com/2.0.0/link/topicrec/AAA...",
                    "author": "Laura Williams"
                },
                {
                    "title": "Music",
                    "link": "http://example.summon.serialssolutions.com/2.0.0/link/topicrec/AAA...",
                    "author": "Laura Williams"
                }
            ],
            "librarianContactInfo": {
                "imageURL": "//libapps.s3.amazonaws.com/accounts/53488/profiles/45497/IMG_1761.jpg",
                "name": "Laura Williams",
                "email": "mailto:laura.williams@duke.edu"
            }
        }
    ],