Versions Compared

Key

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

The “Retrieve Articles of an Issue” endpoint allows a client to retrieve the articles of an issue in the Third Iron metadata database. 

...

Submit a GET request against this endpoint, filling in the appropriate path segments with the id number of your library and the id number of the issue for which you wish to retrieve the articles.   Your application will receive a response representing the articles of that issue.   Responses contain some metadata for each article, such as the article's title, author(s), and start page number.   Responses also contain links to API endpoints through which metadata resources related to each article, such as the article's issue or journal, may be retrieved.   Responses from the endpoint may be paginated.  If so, a cursor value used to retrieve the next page of articles for the issue will be included in the response  

...

PropertyTypeDescription
dataArray of Object

An array of journal resource objects is returned here which represents the journals in the Third Iron metadata database which have issues published within the specified date range.

metaObject

When present, contains metadata about the response

meta.cursorObject

The object within the response metadata that represents a cursor within the dataset that the response represents a page of.

meta.cursor.nextstringA string value which may be passed as a value in the query string parameter named cursor to retrieve the next page of articles in the issue.

Article Resource:

An article resource object represents a journal in the Third Iron metadata database.

...

Property
Type
Description
Optional
idnumber

The article's unique id in the Third Iron system

No
typestringhas the value "articles"No
titlestringThe article's titleYes
datestring

The date of the article

No
authorsstringThe authors of the articleYes
inPressbooleanTrue 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 issueNo
doistringThe article's DOI if Third Iron has the article's DOIYes
abstractstringThe article's abstract id Third Iron has the article's abstractYes
ILLURLstringA link constructed for the library's ILL or document delivery system (when configured) to where the article may be requestedYes
pmidstringWhen the article is available from PubMed, the article's pmid PMID appears here if Third Iron has itYes
fullTextFileURLOn articles where LibKey is aware of a path directly to the PDF file, this property will be availableYes
contentLocationURLOn 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
availableThroughBrowZinebooleanTrue when the article is available within Browzine BrowZine at the specified libraryNo
startPagestringThe page the article starts onYes
endPagestringThe page the article ends onYes
browzineWebLinkURLOn 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.comNo
relationshipsObjectAn object representing relationships between the article resource object and resource objects that represent other records in the Third Iron metadata databaseYes
relationships.issueObjectAn object representing the relationship between the article resource object and the resource object that represents the article's issue in the Third Iron Metadata databaseYes
relationships.issue.linksObjectAn object holding links for the issue relationshipYes
relationships.issue.links.relatedstringA URL path to the API endpoint that retrieves the resource that represents the issue of the articleYes
relationships.journalObjectAn 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 databaseYes
relationships.journal.linksObjectAn object holdings links for the journal relationshipYes
relationships.journal.links.relatedstringA URL path to the API endpoint that retrieves the resource that represents the journal of the articleYes

...

Code Block
languagetext
https://stagingpublic-api.thirdiron.com/public/v1/libraries/222/issues/290003457/articles

...