...
Property | Type | Description |
|---|---|---|
data | Object | An Article Result object is returned if the DOI or PMID is recognized by the Lookup Endpoint |
...
An article result represents an article that the LibKey system is aware of. Responses from the "DOI/PMID lookup" endpoint then describe articles that have DOI/PMID's that LibKey is aware of but are not in the specified BrowZine Library (:library_id) as well as articles that are within that library. A response indicates whether the article referenced by a DOI/PMID is available at the specified library by setting the article result's "availableThroughBrowZine" property to true when the article is available at the library, and false when it is not.
The full list of properties that may appear on a journal result are described in detail in the table below:
If you utilize the optional ?include=journal parameter, you will also receive journal information. The list of properties appearing when this is done is included below:
Example Request, no include for DOI:
| Code Block |
|---|
GET /public/v1/libraries/73/articles/doi/10.1056/NEJMe1702728 |
Example Request, no include for PMID
| Code Block |
|---|
GET /public/v1/libraries/73/articles/pmid/28317425 |
...
A list of libraries will be returned that are active and in trial with privileges to use LibKey. |
Full List of Properties Returned
Property | Type | Description | Optional |
|---|---|---|---|
id | number | The library ID | No |
name | string | The name of the library | No |
type | string | has the value “libraries” | No |
Example Request
| Code Block |
|---|
/public/v1/libraries/libraries?filter[libkey_subscription_status]=active,trial&access_token=xxxxxxxxxx |
Example abbreviated response:
| Code Block | ||
|---|---|---|
| ||
{
"data":[ {
"id": 76582654,{
"typeid": "articles"1525,
"titlename": "AssessmentAbertay of Stable Coronary LesionsUniversity Library",
"datetype": "2017-05-11libraries",
"authors": "Bhatt},
Deepak L.", {
"inPress": false, "doi": "10.1056/NEJMe1702728",
"pmid: "28317425", "openAccessid": false1434,
"fullTextFilename": "https://libkey.io/libraries/73/articles/143256905/full-text-file",
"contentLocation": "https://libkey.io/libraries/73/articles/143256905""Abington - Jefferson Health",
"availableThroughBrowzine": true,
"startPage": "1879",
"endPage": "1881",
"browzineWebLink": "https://browzine.com/libraries/73/journals/10292/issues/36167007?showArticleInContext=doi:10.1056/NEJMe1702728"type":"libraries"
} }
|
...
, |
...
| Code Block |
|---|
GET /public/v1/libraries/73/articles/doi/10.1056/NEJMe1708704?include=journal |
...
| Code Block |
|---|
{ "data": { "id": 765826541104, "typename":"ACU Library"articles", "titletype": "libraries"Assessment of Stable Coronary Lesions", }, "date": "2017-05-11", { "authorsid": "Bhatt1464, Deepak L.", "inPressname": false, "doi": "10.1056/NEJMe1702728", "pmid: "28317425", "openAccess": false"Adelphi University", "fullTextFile": "https://libkey.io/libraries/73/articles/143256905/full-text-file", "contentLocation": "https://libkey.io/libraries/73/articles/143256905",type":"libraries" "availableThroughBrowzine": true}, "startPage": "1879",{ "endPageid": "1881"1994, "browzineWebLinkname": "https://browzine.com/libraries/73/journals/10292/issues/36167007?showArticleInContext=doi:10.1056/NEJMe1702728" "relationships": { "journal": { "data": { "AdventHealth University", "type": "journals", "id": 10292 } }"libraries" } }, "included": [ { "id": 10292, 1712, "typename": "journals",Advocate "title": "New England Journal of Medicine (NEJM)Aurora Health", "issntype": "00284793libraries", "sjrValue": 14.619}, "coverImageUrl": "https://assets.thirdiron.com/images/covers/0028-4793.png", "browzineEnabled": true, "browzineWebLink": "https://browzine.com/libraries/73/journals/10292" } ] } |