API Newspaper article record structure

API Newspaper article record structure

Field Where or how to access this field Description Example value, or list of possible values
article Brief record Container element for a newspaper article.  
article@id Brief record Trove newspaper article id. “18341291″
heading Brief record The article heading “Agriculture around Kelvin Grove and Kedron Brook. [BY OUR AGRICULTURAL REPORTER.]“
category Brief record The type of article. Displayed on the Trove web interface as “Category”
  • Article
  • Advertising
  • Detailed lists, results, guides
  • Family Notices
  • Literature
title Brief record The name of the newspaper or periodical this article is found in. “The Queenslander (Brisbane, Qld. : 1866-1939)”
title@id Brief record The Trove id of the newspaper or periodical this article is found in. Can be used to look up more details. e.g. http://api.trove.nla.gov.au/newspaper/title/42?key=<insert key here> “42″
edition Brief record If this article appeared in a special newspaper/periodical edition, the name of that edition is included here. In the Trove web interface, this is shown on the page view.
e.g. http://trove.nla.gov.au/ndp/del/page/4298413
“2, SPECIAL EDITION TO THE QUEANBEYAN AGE”
date Brief record When the issue this article belongs to was published. YYYY-MM-DD 1876-05-27
page Brief record Determine the sequence of delivery of the pages in an issue. “1″
pageSequence Brief record In addition to the page sequence number, indicates if the article is part of a supplement/section (displayed in the Trove web interface) “1 S”
pageLabel Full Record Sometimes used to indicate what is printed on the page, or perhaps the page number within a section/supplement. Not displayed in the Trove web interface. Sometimes numeric and sometimes not. 

 

e.g. http://api.trove.nla.gov.au/newspaper/45649893?reclevel=full&key=<insert key here>

“Front cover”
status Brief record Included if the article is not currently available. Not included for normal articles. 

 

New articles are included before they are fully approved. These articles have a status of “coming soon”. They don’t include the full text or a link to view the article in Trove. They may be deleted from Trove. If you want to harvest newspaper articles into your own system, you may prefer to only harvest those added more than a month ago, as most articles which are “coming soon” will be approved within this timeframe. If you do harvest any articles which are “coming soon” you will need to check back later to find out whether they still exist/have been approved/get the Trove link and full text.

  • “coming soon” (for articles not yet through the QA process)
  • “withdrawn” (for articles that have been removed for copyright reasons)
relevance Brief record, following a search How relevant the article is to the search
  • very relevant
  • likely to be relevant
  • may have relevance
  • limited relevance
  • vaguely relevant
relevance@score Brief record, following a search A numeric representation of how relevant this article is to the search. This number can be compared to other search results in this zone, but not to results from other zones. “0.009942865″
snippet Brief record, following a search A small amount of article text containing one or more of the search terms. The matching term/s are enclosed in a <B> element “… blue-green plumage holding the <B>tangled</B> loops. A very useful dress it composed of a plaided material …”
troveUrl Brief record A link to view this article in the Trove web interface. If this record was retrieved in response to a search, the search terms will be included in the URL which allows them to be highlighted when viewing in the article. 

 

This is not available for articles with a status of “coming soon”.

The persistent id for this article can be found in the identifier element. (It does not support search term highlighting).

http://trove.nla.gov.au/ndp/del/article/18342701″ 

 

OR

http://trove.nla.gov.au/ndp/del/article/18342701?searchTerm=tangled

trovePageUrl Brief record A link to view the first page of this article, in the Trove web interface. This is not available for articles with a status of “coming soon”. http://trove.nla.gov.au/ndp/del/page/2243685
supplement Full record The newspaper/periodical section this article appeared in. In the Trove web interface, this is shown on the page view. A supplement is part of an issue. “Something to do”
section Full record The newspaper/periodical section this article appeared in. In the Trove web interface, this is shown on the page view. A section is part of an issue. 

 

e.g. http://trove.nla.gov.au/ndp/del/page/4824108

“1, Special Home Feature”
illustrated Full record Flags whether the article is illustrated or not “Y”
wordCount Full record The number of words in the full text of the article “1514″
correctionCount Full record The number of corrections made to the article. Each correction may involve many lines. “1″
listCount Full record The number of  public Trove user created lists this article has been added to. “0″
tagCount Full record The number of public tags added to this article by Trove users. “3″
commentCount Full record The number of public comments added to this article by Trove users. “1″
tag include=tags A public tag added to the article. There may be more than one tag element. “fashion”
tag@lastupdated include=tags When the tag was added. (UTC timezone) “2012-02-20T23:57:57Z”
comment include=comments A public comment added to the article. There may be more than one comment element. “Robert Fuy should probably read Robert Fuz”
comment@lastupdated include=comments When the comment was most recently added/edited. (UTC timezone) “2012-02-20T23:57:57Z”
comment@by include=comments The username of the person who added the comment “public:annmanley”
“rholley” (NLA staff accounts do not include the ‘public’ prefix)
“anonymous” (no user account identified)
list include=lists The name of a public, user created list this article belongs to. There may be more than one list element. “Beacher-Craggs Family”
list@url include=lists A partial URL to retrieve more information about this list using the Trove API. “/list/21922″
list@by include=lists The username of the person who created the list “public:bobbyfamilytree”
“dance” (NLA staff accounts do not include the ‘public’ prefix)
“anonymous” (no user account identified)
list@lastupdated include=lists When the list was most recently added/edited. (UTC timeszone) “2012-02-29T01:02:15Z”
lastCorrection Full record Further information about the most recent correction to this article. The correction itself is not included.  
lastCorrection@by Full record The username of the person who made the most recent correction to this article, or “anonymous” “public:maurielyn”
“rholley” (NLA staff accounts do not include the ‘public’ prefix)
“anonymous” (no user account identified)
lastCorrection@lastupdated Full record When the most recent correction was made to this article (UTC timezone) “2011-12-06T18:05:17Z”
identifier Full record The article identifier. This URL leads to the article view on the Trove web interface. http://nla.gov.au/nla.news-article18341291
pdf Full record A link leading to the pdf for the page this article appears on. There may be more than one pdf element if the article appears over multiple pages.
PDFs are not available for some articles, such as the Australian Women’s Weekly, and articles with a status of “coming soon”.
http://trove.nla.gov.au/ndp/imageservice/nla.news-page2243325/print
articleText include=articletext The full text of the article, including all corrections. Article paragraphs are enclosed in a <p> element.  Lines are enclosed by <span>. 

 

Article text is not available for some articles, such as those from the Australian Women’s Weekly, and articles with a status of “coming soon”. For these articles, there will be no articleText element present.

“<p><span>  SHIPPING  INTELLIGENCE.</span></p> <p><span>  Lying  in  Owen’s  Anchorage.-II.M.S.  Pelorus,</span><span>  and  Champion»</span></p>”

The record structure of newspaper titles is documented here. “The Sydney Morning Herald” is an example of a newspaper title.