Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

BrowZine Journal Availability Request:

...

Each journal result represents a journal that the queried library's collection has access to in some form that has an ISSN (or eISSN) passed in.  Results include both titles that are BrowZine enabled (which allow full Table of Contents browsing), and titles external to Browzine, but within a library's purchased materials.  

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:

PropertyTypeDescriptionOptionalidnumber

The journal's unique id in the Browzine system

Notypestringhas the value "journals"NotitlestringThe journal's titleNoissnstringThe issn
Supported Methods


Code Block
GET


Endpoint Location


Code Block
/public/v1/libraries/:library_id/search


Endpoint Parameters


:library_idReplace the :library_id portion of the endpoint path with the id # of your library
?issns

Supply a querystring parameter of ?issns=issn_list where issn_list is

a comma-delimited list of ISSNs (up to 50) without the dash

...

The browzine journal availability endpoint responds with a JSON object holding an array of journal result objects.  This array is not necessarily in the same order as the order of ISSNs passed in.  Each journal result represents a publication that the library has some entitlement to.   The structure of the response overall and individual journal results are described in the following tables.

Response Object:

...

An Array of Journal Availability objects, sorted by relevance to the query,

may hold up to 50 results


Optional Includes
?include=bookshelvesAdding this include to your request will cause the response to include information about the "bookshelves" on which the title resides.  This includes the name of all three tiers of the taxonomy which contains the title (Subject → Bookcase → Bookshelf) as well as URL's for the given library for each of them so that linking could be provided in either a "breadcrumb" fashion or perhaps just to the shelf so that a link could be created to "browse similar journals".


BrowZine Journal Availability Response:

The browzine journal availability endpoint responds with a JSON object holding an array of journal result objects.  This array is not necessarily in the same order as the order of ISSNs passed in.  Each journal result represents a publication that the library has some entitlement to.   The structure of the response overall and individual journal results are described in the following tables.

Response Object:
PropertyTypeDescription
dataArray of Object

An Array of Journal Availability objects, sorted by relevance to the query,

may hold up to 50 results


Journal Result:

Each journal result represents a journal that the queried library's collection has access to in some form that has an ISSN (or eISSN) passed in.  Results include both titles that are BrowZine enabled (which allow full Table of Contents browsing), and titles external to Browzine, but within a library's purchased materials.  

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:

PropertyTypeDescriptionOptional
idnumber

The journal's unique id in the Browzine system

No
typestringhas the value "journals"No
titlestringThe journal's titleNo
issnstring

The issn for the journal that matches the issn passed in on the endpoint

(formatted with no hyphen)


No
browzineEnabledbooleanTrue when the title is available within Browzine at the specified libraryNo
coverImageUrlstringA url to a small image that can be used to visually depict the journalNo
sjrValuenumberThe Scimago Journal Rank (SJR) - see all their ranking at their website

No

browzineWebLinkURLOn titles that are browzine enabled, this property will be present and will link to the journal's current issue within browzine.comYes
externalLinkURLOn titles that are not browzine enabled, this property may be present. When it is, it is a link to the journal within the library's A-Z systemYes

...

present. When it is, it is a link to the journal within the library's A-Z systemYes


Example Request, two journals, one BrowZine Enabled, the other not:
Code Block
GET /public/v1/libraries/222/search?issns=00220477,00107174

Example Response:
Code Block
languagejs
{
    "data": [
        {
            "id": 52627,
            "type": "journals",
            "title": "Consumer reports",
            "issn": "00107174",
            "sjrValue": 0.12,
            "coverImageUrl": "https://assets.thirdiron.com/images/covers/0010-7174.png",
            "browzineEnabled": false,
            "externalLink": "http://um9mh3ku7s.search.serialssolutions.com/?V=1.0&N=100&L=UM9MH3KU7S&S=I_M&C=0010-7174"
        },
        {
            "id": 3531,
            "type": "journals",
            "title": "Journal of Ecology",
            "issn": "00220477",
            "sjrValue": 4.01,
            "coverImageUrl": "https://assets.thirdiron.com/images/covers/0022-0477.png",
            "browzineEnabled": true,
            "browzineWebLink": "https://browzine.com/libraries/222/journals/3531"
        }
    ]
}
Example Request, two journals, one BrowZine Enabled, the other not, with bookshelves included:
Code Block
GET /public/v1/libraries/222/search?issns=00220477,00107174&include=bookshelves

Example Response:
Code Block
languagejs
{
    "data": [
        {
            "id": 52627,
            "type": "journals",
            "title": "Consumer reports",
            "issn": "00107174",
            "sjrValue": 0.12,
            "coverImageUrl": "https://assets.thirdiron.com/images/covers/0010-7174.png",
            "browzineEnabled": false,
            "externalLink": "http://um9mh3ku7s.search.serialssolutions.com/?V=1.0&N=100&L=UM9MH3KU7S&S=I_M&C=0010-7174",
            "relationships": {
                "bookshelf": {
                    "data": []
                }
            }
        },
        {
            "id": 3531,
            "type": "journals",
            "title": "Journal of Ecology",
            "issn": "00220477",
            "sjrValue": 4.01,
            "coverImageUrl": "https://assets.thirdiron.com/images/covers/0022-0477.png",
            "browzineEnabled": true,
            "browzineWebLink": "https://browzine.com/libraries/222/journals/3531",
            "relationships": {
                "bookshelf": {
                    "data": [
                        {
                            "type": "bookshelf",
                            "id": 314
                        },
                        {
                            "type": "bookshelf",
                            "id": 365
                        }
                    ]
                }
            }
        }
    ],
    "included": [
        {
            "id": 314,
            "name": "Ecology",
            "type": "bookshelf",
            "browzineWebLink": "https://browzine.com/libraries/222/subjects/60/bookcases/91/bookshelves/314",
            "bookcaseName": "Ecology and Evolutionary Biology",
            "bookcaseBrowzineWebLink": "https://browzine.com/libraries/222/subjects/60/bookcases/91",
            "subjectName": "Biological Sciences",
            "subjectBrowzineWebLink": "https://browzine.com/libraries/222/subjects/60"
        },
        {
            "id": 365,
            "name": "Plant Ecology, Evolution, and Systematics",
            "type": "bookshelf",
            "browzineWebLink": "https://browzine.com/libraries/222/subjects/60/bookcases/100/bookshelves/365",
            "bookcaseName": "Plant Sciences/Botany",
            "bookcaseBrowzineWebLink": "https://browzine.com/libraries/222/subjects/60/bookcases/100",
            "subjectName": "Biological Sciences",
            "subjectBrowzineWebLink": "https://browzine.com/libraries/222/subjects/60"
        }
    ]
}


Example Request, two journals, both BrowZine Enabled with bookshelves included:
Code Block
GET /public/v1/libraries/222/search?issns=00220477,10864822&include=bookshelves

Example Response:
Code Block
languagejs
{
    "data": [
        {
            "id": 12598,
            "type": "journals",
            "title": "About Campus",
            "issn": "10864822",
            "sjrValue": 0,
            "coverImageUrl": "https://assets.thirdiron.com/images/covers/1086-4822.png",
            "browzineEnabled": true,
            "browzineWebLink": "https://browzine.com/libraries/222/journals/12598",
            "relationships": {
                "bookshelf": {
                    "data": [
                        {
                            "type": "bookshelf",
                            "id": 1130
                        }
                    ]
                }
            }
        },
        {
            "id": 3531,
            "type": "journals",
            "title": "Journal of Ecology",
            "issn": "00220477",
            "sjrValue": 4.01,
            "coverImageUrl": "https://assets.thirdiron.com/images/covers/0022-0477.png",
            "browzineEnabled": true,
            "browzineWebLink": "https://browzine.com/libraries/222/journals/3531",
            "relationships": {
                "bookshelf": {
                    "data": [
                        {
                            "type": "bookshelf",
                            "id": 314
                        },
                        {
                            "type": "bookshelf",
                            "id": 365
                        }
                    ]
                }
            }
        }
    ],
    "included": [
        {
            "id": 314,
            "name": "Ecology",
            "type": "bookshelf",
            "browzineWebLink": "https://browzine.com/libraries/222/subjects/60/bookcases/91/bookshelves/314",
            "bookcaseName": "Ecology and Evolutionary Biology",
            "bookcaseBrowzineWebLink": "https://browzine.com/libraries/222/subjects/60/bookcases/91",
            "subjectName": "Biological Sciences",
            "subjectBrowzineWebLink": "https://browzine.com/libraries/222/subjects/60"
        },
        {
            "id": 1130,
            "name": "Higher Education",
            "type": "bookshelf",
            "browzineWebLink": "https://browzine.com/libraries/222/subjects/67/bookcases/161/bookshelves/1130",
            "bookcaseName": "Education",
            "bookcaseBrowzineWebLink": "https://browzine.com/libraries/222/subjects/67/bookcases/161",
            "subjectName": "Social Science and Behavioral Science",
            "subjectBrowzineWebLink": "https://browzine.com/libraries/222/subjects/67"
        },
        {
            "id": 365,
            "name": "Plant Ecology, Evolution, and Systematics",
            "type": "bookshelf",
            "browzineWebLink": "https://browzine.com/libraries/222/subjects/60/bookcases/100/bookshelves/365",
            "bookcaseName": "Plant Sciences/Botany",
            "bookcaseBrowzineWebLink": "https://browzine.com/libraries/222/subjects/60/bookcases/100",
            "subjectName": "Biological Sciences",
            "subjectBrowzineWebLink": "https://browzine.com/libraries/222/subjects/60"
        }
    ]
}

...