Versions Compared

Key

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

...

There is a lot of information there which you might consider utilizing and that which is covered in detail in the reference guide here but to get you started the most important elements are listed below including recommended order of usage:

Property

Type

Description

Optional

retractionNoticeUrl

URL

Will appear if the article has been retracted with a link to a LibKey.io URL which provides more information about the retraction with data from Retraction Watch. This field is optional but we recommend looking for this element FIRST and displaying this URL instead of or in addition to a “fullTextFile” or “contentLocation” link so that users can be made aware of the retraction status of the article they are viewing.

Yes

expressionOfConcernUrl

URL

Will appear if the article has an Expression of Concern associated and will have a link to a http://LibKey.io URL which provides a link to the original Expression of Concern

Yes

fullTextFile

URL

On articles where LibKey is aware of a path directly to the PDF file, this property will be available. Look for this next and display it if there is no Retraction Notice available.

Yes

contentLocation

URL

On articles where LibKey is aware of a path to the web page where the article is available, this property will be available.  This can include non-publisher sources such as aggregators and repositories. Sometimes articles will have a fullTextFile AND a contentLocation and other times ONLY a contentLocation. Depending on your goals you may choose to display only one (typically prefering fullTextFile) or BOTH of these to give users options.

Yes

openAccess

boolean

True if the article is open access via the publisher and False if it is not.  LibKey.io links corresponding to this article which have an openAccess value of "True" will not include any institutional authentication. You may wish to make use of this if you want to display an “Open Access” badge or icon of some kind next to the article.

No

browzineWebLink

URL

On titles that are BrowZine enabled, this property will be present and will link to the article in the context of its issue (or articles in press list as appropriate) on browzine.com You may wish to make use of this if you want to provide an article in context experience into BrowZine. A popular integration point in all of the commercially available discovery systems (Primo, Summon, EDS, OCLC WorldCat, Discovery, TDNet Discovery, etc.)

No

Optional Include to get Journal Information

...

Importantly are these two elements for implementation consideration:

Property

Type

Description

Optional

sjrValue

number

The SJR (Scimago Journal Rank) value of the journal. Utilize to display this value in your interface to show the general prestige of this journal.

No

coverImageUrl

URL

The link to the cover image. Use this element to feature a representative cover image of the title in your interface.

No

Info

More questions? We are here to help!

Please drop us a line at support@thirdiron.com to start the conversation and thanks for your interest in LibKey!