The “Retrieve Articles of an Issue” endpoint allows a client to retrieve the articles of an issue in the Third Iron metadata database. Optionally, the endpoint can fetch articles within an issue that contain new content over a specific date range.
...
Supported Methods |
|
|---|---|
Endpoint Location |
|
Endpoint Parameters | |
:library_id | Replace the :library_id portion of the endpoint path with the id # of your library |
:issue_id | Replace the :issue_id portion of the endpoint path with the id # of the issue for which you're retrieving articles |
?cursor | When navigating through paginated data, pass the cursor value that points to the page of data your interested in as a value for the query string parameter named |
new_content_start_date | Optional query string parameter. If present, Format this value as When present, this will cause the endpoint to only include articles from the specified issue that became part of that issue between This value must be earlier or equal to For accurate results, this date should be no earlier than August 5, 2022. |
new_content_end_date | Optional query string parameter. If present, Format this value as When present, this will cause the endpoint to only include issues became part of that issue between This value must be later or equal to |
...
Property | Type | Description | Optional |
|---|---|---|---|
id | number | The article's unique id in the Third Iron system | No |
type | string | has the value "articles" | No |
title | string | The article's title | Yes |
date | string | The date of the article | No |
authors | string | The authors of the article | Yes |
inPress | boolean | True when the article is not yet assigned to a regularly published issue and is considered an "Article in Press". False when it is in a regularly published issue | No |
doi | string | The article's DOI if Third Iron has the article's DOI | Yes |
abstract | string | The article's abstract id Third Iron has the article's abstract | Yes |
ILLURL | string | A link constructed for the library's ILL or document delivery system (when configured) to where the article may be requested | Yes |
pmid | string | When the article is available from PubMed, the article's PMID appears here if Third Iron has it | Yes |
fullTextFile | URL | On articles where LibKey is aware of a path directly to the PDF file, this property will be 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. | Yes |
availableThroughBrowZine | boolean | True when the article is available within BrowZine at the specified library | No |
openAccess | boolean | True when the article is open access, false otherwise. | Yes |
retractionNoticeUrl | URL | If an article has been retracted, the attribute will be present, and have a URL to a page that will give more information about the retraction. | Yes |
startPage | string | The page the article starts on | Yes |
endPage | string | The page the article ends on | Yes |
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 | No |
relationships | Object | An object representing relationships between the article resource object and resource objects that represent other records in the Third Iron metadata database | Yes |
relationships.issue | Object | An object representing the relationship between the article resource object and the resource object that represents the article's issue in the Third Iron Metadata database | Yes |
relationships.issue.links | Object | An object holding links for the issue relationship | Yes |
relationships.issue.links.related | string | A URL path to the API endpoint that retrieves the resource that represents the issue of the article | Yes |
relationships.journal | Object | An object representing the relationship between the article resource object and the resource object that represent's the article's journal in the Third Iron metadata database | Yes |
relationships.journal.links | Object | An object holdings links for the journal relationship | Yes |
relationships.journal.links.related | string | A URL path to the API endpoint that retrieves the resource that represents the journal of the article | Yes |
...