Search Endpoint
The BrowZine Search Endpoint allows your application to integrate with the search functionality that powers the search on browzine.com.
Submit a GET request against this endpoint with a search query and your application will get a response representing the results that would be presented to a user if they were to perform that same search query within the journal/subject search of browzine.com. Responses contain an array of result objects of two types: journal results and subject area results. The array returned in the response is ordered according to relevance to the submitted search query using the same rules as the browzine.com search.
BrowZine Search Request:
| Supported Methods | |
|---|---|
| Endpoint Location | |
Endpoint Parameters | |
| :library_id | Replace the :library_id portion of the endpoint path with the id # of your library |
| ?query | Supply a querystring parameter of ?query=[searchQuery] where [searchQuery] is a urlencoded representation of the search you wish to perform against your library's journals and subject areas |
BrowZine Search Response:
The browzine search endpoint responds with a JSON object holding an array of result objects. This array is ordered by relevance to the search query. Like the search in browzine.com, there are two kinds of search results: journal results and subject results. Each journal result represents a publication that the library has some entitlement to, and each subject area result represents a taxonomic category in the browzine system that your library's collection has content within. The structure of the response overall and individual journal and subject results are described in the following tables and an example of search for "Bio" may also be found below.
Response Object:
| Property | Type | Description |
|---|---|---|
| data | Array of Object | An Array of Journal Result objects and Subject Result objects, sorted by relevance to the query, may hold up to 250 results |
Journal Result:
Each journal result represents a journal that the queried library's collection has access to in some form that is revelent to the searched for query. Results include both titles that are BrowZine enabled and thus enjoy full TOC browsing support, the ability to add these titles to My Bookshelf and so on as well as Externally Linked titles that Browzine does not natively support, but that are found within the library's collection. Whether a title is supported by the browzine.com application is captured by the browzineEnabled property of the result object. Results for journals that are browzineEnabled at the queried library will have a browzineWebLink that links to the journal within browzine.com, and results for journals that are not browzineEnabled will have an externalLink property that links to the journal in the queried library's A-Z system if the queried library has been configured to integrate with the library's A-Z system. Each browzineEnabled journal result also provides a coverImageUrl that can be used to visually depict the journal within your application.
The full list of properties that may appear on a journal result are described in detail in the table below:
| Property | Type | Description | Optional |
|---|---|---|---|
| id | number | The journal's unique id in the Browzine system | No |
| type | string | For a journal result, the type will have value "journals" | No |
| title | string | The journal's title | No |
| issn | string | An issn for the journal (formatted with no hyphen) | No |
| browzineEnabled | boolean | True when the title is available within Browzine at the specified library | No |
| coverImageUrl | string | A url to a small image that can be used to visually depict the journal | No |
| sjrValue | number | The Scimago Journal Rank (SJR) - see all their ranking at their website | No |
| browzineWebLink | string | On titles that are browzine enabled, this property will be present and will link to the journal within browzine.com | Yes |
| externalLink | string | On titles that are not browzine enabled, this property may be present and when it is will link to the journal within the library's A-Z system | Yes |
Subject Result:
Each subject result represents a taxonomic category that the queried library's collection contains some publication within the category and whose name is relevant to the searched for query. Results include the name of the subject area and a link to the subject area in browzine.com.
| Property | Type | Description | Optional |
|---|---|---|---|
| id | number | The subject's unique id in the Browzine system | No |
| type | string | For a subject result, the type will have value "subjects" | No |
| name | string | The name of the subject area | No |
| browzineWebLink | string | A link to the subject area within Browzine Web | No |