API - Work record structure

A work is made up of one or more versions. A version is made up of one or more records.

Fields available in the brief record are also available in the full record.

Work records are based on Dublin Core.

Field Where or how to access this field Description Example value, or list of possible values
work Brief record Container for all other elements describing the work.
work@id Brief record The Trove work id "123456789"
troveUrl Brief record A link to view this article in the Trove web interface.
title Brief record The title or name of the work. "Tangled : the essential guide to Rapunzel's world / written by Barbara Bazaldua"
contributor Brief record The main creator of this work. Some works have multiple creators listed, others have only one even if multiple creators exist. "Bazaldua, Barbara"
issued Brief record The year/s this work was issued, created or published. May also include month and day. May be a range. 

YYYY-MM-DD
YYYY-MM
YYYY

YYYY-YYYY

"2011"
"2001-2011"
type Brief record The format of this work. There may be more than one type element. "Book/Illustrated"
See the list of possible format values below.
isPartOf Brief record For articles, the journal or periodical this article belongs to (if known). 

@url may include the API access point to get more information about this periodical e.g. "/work/13110632"

"Access"
subject Full record Subjects describe what a work is about. A variety of vocabularies are used, including LCSH

More than one subject element may be present.

"Global warming -- Health aspects."
abstract Full record A description, summary, abstract, or first few words of this work, if available. "Damaged rainforest trees in a backyard in Babinda."
tableOfContents Full record A table of contents for this work, if available. 

Where possible, each item is listed on a separate line within the same tableOfContents element.

"<tableOfContents>Executive summary
Introduction
Causes of climate change
Trends and projections of physical changes</tableOfContents>"
language Full record The language/s this work is available in. More than one language element may be present. "English"
wikipedia Full record Links to any known associated wikipedia articles. Includes markup. "Read associated articles: <a href="http://en.wikipedia.org/wiki/Golomb_coding"> Golomb coding</a>, <a href="http://en.wikipedia.org/wiki/Incremental_encoding"> Incremental encoding</a>"
holdingsCount Brief record The number of organisations (libraries, archives, etc) who have a copy of this work. "5"
versionCount Brief record A work is made up of one or more versions. This is the number of versions that are grouped together to make up this work. "2"
tagCount Full record Tags can be placed on the work as a whole, or on a particular version that is part of the work. This element shows the number of public tags on this work or any of its versions. There is no way to access private tags through the API. "5"
tagCount@level="work" Full record The number of public tags on this work (not including tags placed on a particular version.) "4"
commentCount Full record Comments can be placed on the work as a whole, or on a particular version that is part of the work. This element shows the number of public comments on this work or any of its versions. "1"
commentCount@level="work" Full record The number of public comments on this work (not including comments placed on a particular version.) "0"
listCount Full record The number of public lists this work is in. "1"
tag include=tags A public tag added to the work. There may be more than one tag element. Tags can also be added to a version (the version/tag element). "lightning"
tag@lastupdated include=tags When the tag was added. (UTC timezone) “2011-12-12T15:44:01Z″
comment include=comments A public comment added to the work. There may be more than one comment element. Comments can also be added to a version (the version/comment element). “Have any names been listed as to who is in the photo?”
comment@lastupdated include=comments When the comment was most recently added/edited. (UTC timeszone) "2011-12-09T09:43:00Z"
comment@by include=comments The username of the person who added the comment. “public:bobbyfamilytree”
“rholley” (NLA staff accounts do not include the ‘public’ prefix)
“anonymous” (no user account identified)
comment@rating include=comments An optional rating of the item from 0 to 5 5
list include=lists The name of a public, user created list this work 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"
identifier@type="url"
@linktype="fulltext","restricted","unknown"
Brief record includes one URL.
Add "include=links" to access  any other URLs.
If available, the best known link to this work is included automatically in the brief record. 

@linktype indicates the type of URL. Possible values are listed below.

@linktext may also be provided.

<identifier type="url" linktype="fulltext" linktext="View online">http://ebooks.adelaide.edu.au/t/turgenev/ivan/dog/</identifier>
identifier@type="url"
@linktype="subscription"
include=subscribinglibs A link to access this work through a particular organisation's subscription. 

@nuc - the NUC symbol for the organisation that has the subscription.

@library - in future will be the API access point for more information about the organisation that has the subscription. e.g. "/library/ABS"

"http://trove.nla.gov.au/goto?i=subs&w=151678302&d=VLINK%2Fnuc%3DABS%2Fitem%3D165507387%2Fdb%3DIELHSS%2F"
identifier@type="url"
@linktype="thumbnail"
Brief record If available, a link to a thumbnail-sized image representing this item. 

Note that book  cover art is not available. It can be sourced separately through services such as Nielsen BookData or Amazon.

"http://bishop.slq.qld.gov.au:80/webclient/DeliveryManager?pid=282557"
holding include=holdings A container element for information about a copy of this work held by a particular organisation (library, archive, etc).
holding@nuc include=holdings The NUC symbol of an organisation with a copy of this work. 

The NUC symbol (ID) can be used to retrieve more information about the organisation.

"NWU"
holding@name include=holdings The name of an organisation which controls a copy of this work. Provided instead of a NUC symbol for organisations which do not have one assigned. "Internet Archive"
holding@library include=holdings In future, this will be the API access point to look up more information about this organisation. "/library/NWU"
holding/url@type="deepLink","catalogue","homepage" include=holdings "deepLink" - a link to view this item in the holding institution's catalogue/website. 

"catalogue" - a link to the holding institution's  catalogue home page.

"homepage" - a link to the organisation's homepage

The best available link is shown.

"http://catalogue.slwa.wa.gov.au/search~S2/i?SEARCH=2268040259"
holding/callNumber include=holdings The institution's call number for their copy of the work. 

More than one callNumber may be present.

@localIdentifier is also provided if available. From Libraries Australia MARC records, this is extracted from 850$b

"<.B16766362>"
version include=workversions A container element for a version/edition that is part of this work. Versions usually contain one record but can sometimes contain several.
version@id include=workversions A string of internal Trove ids for any records that make up this version.
version/record include=workversions Container element for a Dublin Core record. These records are contributed to Trove from various sources and have often been converted by Trove or the original contributor to Dublin Core from other formats. Only selected child elements are described below.
version/record/identifier@type="control number" @source="OCoLC" include=workversions The OCLC number for this record. "660539373"
version/record/identifier@type="control number" @source="AuCNLKIN" include=workversions The Libraries Australia ID for this record. "000046285585"
version/record/metadataSource include=workversions The name of the organisation or aggregating service who contributed this record to Trove. "Libraries Australia" 

 

version/record/metadataSource@type="nuc" include=workversions The NUC symbol of the organisation who contributed this this record to Trove. 

The NUC symbol (ID) can be used to retrieve more information about the organisation.

"QCCL"
version/type include=workversions The format of this version. There may be more than one type element. "Book/Illustrated" 

See the list of possible format values below.

version/issued include=workversions The date this version was issued/published/created. 

YYYY
OR
YYYY-MM
OR
YYYY-MM-DD

"1980-01-31"
version/holdingsCount include=workversions The number of institutions (libraries, archives, etc) who have or control a copy of this work. "1"
version/tagCount@level="version" include=workversions The number of public tags on this version (not including tags placed at the work level.) "1"
version/commentCount@level="version" include=workversions The number of public comments on this version (not including comments placed at the work level.) "1"
version/tag include=workversions,tags See documentation for tag above.
version/comment include=workversions,comments See documentation for comment above.
version/identifier@type="url" include=workversions,links A URL associated with this version
 

@linktype indicates the type of URL. Possible values are listed below.

(@linktype="subscription" is not included here.)

version/identifier@type="url" @linktype="subscription" include=workversions,subscribingLibs Link to access this version via a particular organisation's subscription. 

See documentation for identifier above.

version/holding include=workversions,holdings See documentation for holding above.

List of possible formats

  • Archived website
  • Art work
  • Article
    • Article/Abstract
    • Article/Book chapter
    • Article/Conference paper
    • Article/Journal or magazine article
    • Article/Other article
    • Article/Report
    • Article/Review
    • Article/Working paper
  • Audio book
  • Book
    • Book/Braille
    • Book/Illustrated
    • Book/Large print
  • Conference Proceedings
  • Data set
  • Map
    • Map/Aerial photograph
    • Map/Atlas
    • Map/Braille
    • Map/Electronic
    • Map/Globe or object
    • Map/Large print
    • Map/Map series
    • Map/Microform
    • Map/Single map
  • Object
  • Periodical
    • Periodical/Journal, magazine, other
    • Periodical/Newspaper
  • Photograph
  • Poster, chart, other
  • Published
  • Sheet music
  • Sound
    • Sound/Interview, lecture, talk
    • Sound/Other sound
    • Sound/Recorded music
  • Thesis
  • Unpublished
  • Video
    • Video/Captioned

List of possible linktype values

Trove tries to interpret how accessible a link is and whether it leads to the actual item, or something else instead (like a finding aid, a blurb or a related website).  The resulting categories are provided as a guide only, and are not correct in all cases.

Linktype value Trove display label (on brief results screen) Does this URL lead to an online, digital copy of this item? Access conditions?
fulltext "View  online" Yes No
restricted "View online (access conditions)" Yes Yes - payment or membership may be required before the item can be accessed
subscription "View online (access conditions)" Yes Yes - payment or membership may be required before the item can be accessed
unknown "Possibly online" Maybe - Trove is unsure about this link -
notonline - No, it leads to a related item (such as a finding aid) -
thumbnail - No, it leads to a thumbnail representing this item No