API List record structure

API List record structure

Field Where or how to access this field Description Example value, or list of possible values
list Brief record Container for all other elements describing the list.  
list@id Brief record The Trove list id “1234″
list@url Brief record A link to view this list through the Trove API. (Stick it on the end of the api base URL and add your key) “/list/1234″
troveUrl Brief record A link to view this list in the Trove web interface. http://trove.nla.gov.au/list?id=1234
title Brief record The name of the list. List names are not unique. Display them in conjunction with the list creator’s username. “Adelaide Festival of the Arts (1960 – )”
creator Brief record The username of the person who created the list. (Anonymous lists are not allowed.) “public:bobbyfamilytree”
“rholley” (NLA staff accounts do not include the ‘public’ prefix)
listItemCount Brief record The number of items in the list “11″
identifier @type=”url” @linktype=”thumbnail” Brief record A link to a thumbnail image for the list http://nla.gov.au/nla.pic-vn3260737-t
description Brief record (truncated to 120 characters)
Full record (full value)
The description of the list. May be quite long. May contain markup. <p><em>Furioso</em> premiered on 8 July 1993 at the Playhouse, Adelaide Festival Centre. It was choreographed by Meryl Tankard for Meryl Tankard Australian Dance Theatre. The original cast was Prue Lang, Mia Mason, Rachel Roberts, Tuula Roppola, Michelle Ryan, Vincent Crowley, Grayson Millwood, Shaun Parker, Gavin Webber and Steev Zane. It was danced to music by Arvo Part, Elliot Sharp and Henryk Gorecki, and had designs by Regis Lansac.</p>
date@created Full record When the list was created. (UTC timezone) “2009-12-31T13:00:00Z”
date@lastupdated Full record When the list was last changed. (UTC timezone) “2010-09-06T05:07:41Z”
tagCount Full record The number of tags on this list “1″
commentCount Full record The number of comments on this list “0″
tag include=tags A public tag added to the work. There may be more than one tag element. “dance”
tag@lastupdated include=tags When the tag was added. (UTC timezone) “2012-02-29T01:11:10Z”
comment include=comments A public comment on this list. There may be more than one comment element. “I have found this list very valuable as a teaching resource”
comment@by include=comments The username of the person who added this comment. “public:bobbyfamilytree”
“rholley” (NLA staff accounts do not include the ‘public’ prefix)
“anonymous” (no user account identified)
comment@lastupdated include=comments When this comment was created or last edited. “2012-02-29T01:11:19Z”
listItem include=listItems An item that belongs to the list. This may be a work, a digitised newspaper article, a person/organisation, or a link to an external website. 

 

There may be more than one listItem element.

A list item will contain one of the following elements: work, article, externalWebsite, people. It may also contain a note.

 
listItem/note include=listItems A note the creator of the list wrote about this item, such as why they decided to include it, or extra description of the item. “Henry Thomas Byrnes Death Notice”
listItem/work include=listItems brief record for a work that belongs to this list.  
listItem/article include=listItems brief record for a digitised newspaper article that belongs to this list.  
listItem/externalWebsite include=listItems Information about a link to page outside of Trove that has been included in this list.  
listItem/externalWebsite/title include=listItems The name of the webpage (as entered by the creator of the list). “Google”
listItem/externalWebsite/identifier@type=url include=listItems The URL of the webpage. http://google.com.au
listItem/people include=listItems A very brief record for a person or organisation that belongs to this list.  
listItem/people@id include=listItems The Trove id for the person or organisation. “725090″
listItem/people/troveUrl include=listItems A link to view the person or organisation on the Trove website. http://trove-test.nla.gov.au/people/725090