element. Lines are enclosed by . 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."
},
"warning": {
"type": "string",
"description": "A message to indicate if a newspaper article is not present in the newspaper database, but exists in the Trove index"
}
},
"$defs": {
"article": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Trove newspaper article id."
},
"url": {
"type": "string",
"description": "Trove newspaper url."
},
"identifier": {
"type": "string",
"description": "The article identifier. This URL leads to the article view on the Trove web interface."
},
"heading": {
"type": "string",
"description": "The article heading"
},
"category": {
"type": "string",
"enum": [
"Article",
"Advertising",
"Detailed lists, results, guides",
"Family Notices",
"Literature",
"Government Gazette Notices",
"Government Gazette Tenders and Contracts",
"Government Gazette Proclamations And Legislation",
"Government Gazette Private Notices",
"Government Gazette Budgetary Papers",
"Government Gazette Index And Contents",
"Government Gazette Appointments And Employment",
"Government Gazette Freedom Of Information"
],
"description": "The type of article. Displayed on the Trove web interface as “Category”"
},
"title": {
"description": "The name of the newspaper or periodical this article is found in.",
"$ref": "#/$defs/articleTitle"
},
"edition": {
"type": "string",
"description": "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. https://trove.nla.gov.au/ndp/del/page/4298413"
},
"date": {
"type": "string",
"description": "When the issue this article belongs to was published. YYYY-MM-DD."
},
"page": {
"type": "string",
"description": "Determine the sequence of delivery of the pages in an issue."
},
"pageSequence": {
"type": "string",
"description": "In addition to the page sequence number, indicates if the article is part of a supplement/section (displayed in the Trove web interface)"
},
"pageLabel": {
"type": "string",
"description": "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."
},
"status": {
"type": "string",
"enum": [
"coming soon",
"withdrawn",
"currently unavailable"
],
"description": "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."
},
"relevance": {
"$ref": "#/$defs/relevance"
},
"snippet": {
"type": "string",
"description": "A small amount of article text containing one or more of the search terms. The matching term/s are enclosed in a element"
},
"troveUrl": {
"type": "string",
"description": "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)."
},
"trovePageUrl": {
"type": "string",
"description": "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”."
},
"supplement": {
"type": "string",
"description": "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."
},
"section": {
"type": "string",
"description": "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."
},
"illustrated": {
"type": "string",
"enum": [
"Y",
"N"
],
"description": "Flags whether the article is illustrated or not"
},
"wordCount": {
"type": "string",
"description": "The number of words in the full text of the article"
},
"correctionCount": {
"type": "string",
"description": "The number of corrections made to the article. Each correction may involve many lines."
},
"tagCount": {
"type": "string",
"description": "The number of public tags added to this article by Trove users."
},
"commentCount": {
"type": "string",
"description": "The number of public comments added to this article by Trove users."
},
"listCount": {
"type": "string",
"description": "The number of public Trove user created lists this article has been added to."
},
"tag": {
"type": "array",
"items": {
"$ref": "#/$defs/tag"
},
"description": "A public tag added to the article. There may be more than one tag element."
},
"comment": {
"type": "array",
"items": {
"$ref": "#/$defs/comment"
},
"description": "A public comment added to the article. There may be more than one comment element."
},
"list": {
"type": "array",
"items": {
"$ref": "#/$defs/list"
},
"description": "The name of a public, user created list this article belongs to. There may be more than one list element"
},
"lastCorrection": {
"type": "object",
"description": "Further information about the most recent correction to this article. The correction itself is not included.",
"properties": {
"by": {
"type": "string",
"description": "The username of the person who made the most recent correction to this article, or “anonymous”"
},
"lastupdated": {
"type": "string",
"description": "When the most recent correction was made to this article (UTC timezone)"
}
}
},
"pdf": {
"type": "array",
"items": {
"type": "string"
},
"description": "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”."
},
"articleText": {
"type": "string",
"description": "The full text of the article, including all corrections. Article paragraphs are enclosed in a element. Lines are enclosed by . 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."
},
"warning": {
"type": "string",
"description": "A message to indicate if a newspaper article is not present in the newspaper database, but exists in the Trove index"
}
}
},
"articleTitle": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the newspaper or gazette title."
},
"title": {
"type": "string",
"description": "Name of the newspaper (or magazine, gazette)"
},
"state": {
"type": "string",
"enum": [
"International",
"National",
"ACT",
"New South Wales",
"Northern Territory",
"Queensland",
"South Australia",
"Tasmania",
"Victoria",
"Western Australia"
],
"description": "The state the newspaper or gazette was primarily published in."
},
"issn": {
"type": "string",
"description": "International Standard Serial Number"
},
"publisher": {
"type": "string",
"description": "The name of the publisher, where available"
},
"place": {
"type": "array",
"items": {
"type": "string"
},
"description": "Place is the geographic region the item is about (geographic coverage) and includes Australian states and territories and a number of Australia's closest International neighbours"
},
"alternateTitles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Other names for this title"
},
"troveUrl": {
"type": "string",
"description": "A link to view this newspaper or gazette title in Trove"
},
"startDate": {
"type": "string",
"description": "The publication date of the easliest issue of this newspaper available in Trove, in the format YYYY-MM-DD."
},
"endDate": {
"type": "string",
"description": "The publication date of the most recently issue of this newspaper or gazette available in Trove, in the format YYYY-MM-DD."
},
"year": {
"type": "array",
"description": "A list of the publication years for this newspaper or gazette that are included in Trove.",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "A year this newspaper or gazette title was published, in the format YYYY."
},
"issuecount": {
"type": "integer",
"description": "The number of issues published in this year."
},
"issue": {
"type": "array",
"description": "Information about a particular issue of this newspaper or gazette",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Issue id"
},
"date": {
"type": "string",
"description": "Date this issue was published, the format YYYY-MM-DD"
},
"url": {
"type": "string",
"description": "URL to view this issue in Trove"
}
}
}
}
}
}
}
}
},
"comment": {
"type": "object",
"properties": {
"lastupdated": {
"type": "string",
"description": "When the comment was most recently added/edited (UTC timezone)."
},
"by": {
"type": "string",
"description": "The username of the person who added the comment."
},
"rating": {
"type": "string",
"description": "An optional rating of the item from 0 to 5."
},
"value": {
"type": "string",
"description": "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)."
}
}
},
"dcRecord": {
"type": "object",
"description": "Container element for a Dublin Core record",
"properties": {
"title": {
"type": "array",
"items": {
"type": "string"
},
"description": "A name given to the resource."
},
"type": {
"type": "array",
"description": "The nature or genre of the resource.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The nature or genre of the resource."
},
"type": {
"type": "string",
"description": "Used to identify which Trove category the item belongs in (e.g. book, thesis, audio, video, chart, diagram, etc)."
}
}
}
},
"alternative": {
"type": "array",
"description": "The alternate name (alternative title) for the item",
"items": {
"type": "string"
}
},
"creator": {
"type": "array",
"description": "An entity primarily responsible for making the resource. Examples of a Creator include a person, an organisation, or a service.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the entity."
},
"type": {
"type": "string",
"description": "The type of entity (e.g. author, illustrator)."
}
}
}
},
"contributor": {
"type": "array",
"description": "An entity responsible for making contributions to the resource. Examples of a Contributor include a person, an organisation, or a service.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The name of the entity."
},
"type": {
"type": "string",
"description": "The type of contributor. Examples include: conferenceOrganiser, owner, photographer."
}
}
}
},
"issued": {
"type": "array",
"description": "Date of formal issuance (e.g., publication) of the resource. ISO-8601 format dates are used, ie yyyy-mm-dd.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The date."
},
"type": {
"type": "string",
"description": "The type of issuance"
}
}
}
},
"description": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The description text."
},
"type": {
"type": "string",
"description": "The type of description. Examples include: byline, fulltext, open_fulltext, scale."
}
}
},
"description": "An account of the resource. Description may include an abstract, a byline or a free-text account of the resource. When the fulltext of an article is available, include it in a description field with the additional attribute type=”fulltext”. Trove will index this text (return the record for a search on a word in the fulltext) but only display the first 200 characters. Users will need to visit your site to view the fulltext. Trove will only index the first 30,000 characters of a description field."
},
"date": {
"type": "array",
"items": {
"type": "string"
},
"description": "A point or period of time associated with an event in the lifecycle of the resource. ISO-8601 format dates are used, ie yyyy-mm-dd."
},
"coverage": {
"type": "array",
"items": {
"type": "string"
},
"description": "The spatial or temporal topic of the resource, the spatial applicability of the resource, or the jurisdiction under which the resource is relevant. Spatial topic and spatial applicability may be a named place or a location specified by its geographic coordinates. Temporal topic may be a named period, date, or date range. A jurisdiction may be a named administrative entity or a geographic place to which the resource applies. Use of a controlled vocabulary is encouraged but not mandatory."
},
"subject": {
"type": "array",
"description": "The topic of the content of the resource. Use of a controlled vocabulary such as the Australian Pictorial Thesaurus, LCSH or the Australian Extension to LCSH is encouraged but not mandatory.",
"items": {
"type": "string"
}
},
"format": {
"type": "array",
"description": "The physical format of the item",
"items": {
"type": "string"
}
},
"extent": {
"type": "array",
"items": {
"type": "string"
},
"description": "The size or duration of the resource, e.g. the number of pages, size of a computer file or length of a sound recording."
},
"audience": {
"type": "array",
"items": {
"type": "string"
},
"description": "A class of entity for whom the resource is intended or useful, e.g. Academic, Professional"
},
"abstract": {
"type": "array",
"description": "A description, summary, abstract, or first few words of this work, if available.",
"items": {
"type": "string"
}
},
"tableOfContents": {
"type": "string",
"description": "A list of subunits of the resource, e.g. Book chapter headings. This field is split on “-- “ and displayed as a list."
},
"language": {
"type": "array",
"description": "A language of the resource. ISO-639-2 is preferred (3 letter language codes). Plain text can also be used. If your system keeps ISO-639-1 language codes, combines a language with a country code (ISO-3166), or uses another standard please let the Trove team know at setup time. A special mapping will be applied to your data. Austlang (Aboriginal and Torres Strait Islander languages) codes may be added to this field as described at Austlang Codes.",
"items": {
"$ref": "#/$defs/language"
}
},
"temporal": {
"type": "array",
"description": "Temporal characteristics of the resource. This can be a year, date range or named period.",
"items": {
"type": "string"
}
},
"publisher": {
"type": "array",
"description": "An entity responsible for making the resource available. Examples of a publisher include a person, an organisation, or a service. Typically, the name of a publisher should be used to indicate the entity.",
"items": {
"type": "string"
}
},
"references": {
"type": "array",
"description": "The URL of a related resource that is referenced, cited, or otherwise pointed to by the described resource.",
"items": {
"type": "string"
}
},
"relation": {
"type": "array",
"description": "A related resource; a version of the work, or a significant part of the work. Recommended best practice is to reference the resource by means of a string or number conforming to a formal identification system, for example a permanent URL. ARC or NHMRC grant numbers can also be entered as a permanent URL.",
"items": {
"type": "string"
}
},
"medium": {
"type": "array",
"description": "The material or physical carrier of the resource.",
"items": {
"type": "string"
}
},
"licenseRef": {
"type": "array",
"description": "A URL pointing to a licence – ideally human and machine readable – that explains the terms for use or re-use of the content. RightsStatements.org URLs need to point to the Persistant link to the statement. URLs from Creative Commons and RightsStatements.org are used to populate the rights facets in Trove.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The licence URL."
},
"startDate": {
"type": "string",
"description": "the date at which these licence conditions begin to apply"
}
}
}
},
"identifier": {
"type": "array",
"description": "A local system identifier OR A URL to the resource, a version of the resource, or a related item. For long-term viability of the record a permanent URL such as a handle or purl should be used, rather than a system-specific URL. Include the linktype attribute will give Trove further data about the nature of the resource available, and should be included with all URLs.",
"items": {
"$ref": "#/$defs/identifier"
}
},
"spatial": {
"type": "array",
"items": {
"$ref": "#/$defs/spatial"
},
"description": "Spatial characteristics of the resource, e.g. the location a photograph was taken; can also be used to include MARC Geographic Area Codes (GAC) to apply place facets."
},
"isPartOf": {
"type": "array",
"description": "A related resource in which the described resource is physically or logically included, e.g. a photograph or manuscript collection",
"items": {
"$ref": "#/$defs/isPartOf"
}
},
"bibliographicCitation": {
"type": "array",
"description": "A bibliographic reference for the resource. Recommended practice is to include sufficient bibliographic detail to identify the resource as unambiguously as possible.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The citation text."
},
"type": {
"type": "string",
"description": "The type of citation. Examples of bibliographic citation types include: publication, volume, issue, pagination, edition, eisbn, isbn, issn, dateIssues, placeOfPub, sourceCreator, dateIssued, yearIssued."
}
}
}
},
"rights": {
"type": "array",
"description": "Information about rights held in and over the resource. Copyright should be asserted if known. Free text or a URI is acceptable e.g. link to a Creative Commons licence. For better display in Trove a standard licence should be included in the Licence Ref element instead. Rights statements starting with a Creative Commons or RightsStatements.org URI will populate the rights facet with appropriate data.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The rights statement."
},
"type": {
"type": "string",
"description": "The type of rights statement (e.g. metadata)."
}
}
}
},
"freeToRead": {
"type": "array",
"description": "Indicates an Open Access item. Including the free_to_read element indicates any user can freely access the full item online without authenticating or having to pay. No content is required in this tag, its presence indicates an item is Open Access and its absence indicates an item is not Open Access.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The free to read statement, if present."
},
"startDate": {
"type": "string",
"description": "the date on which an item becomes free to read, for example when an embargo is lifted. This date should be in ISO-8601 format, ie yyyy-mm-dd."
},
"endDate": {
"type": "string",
"description": "the date on which the item ceases to be free to read, for example when a free trial period ends. This date should be in ISO-8601 format, ie yyyy-mm-dd."
}
}
}
},
"viewcopy": {
"type": "array",
"items": {
"type": "string"
},
"description": "The URL of a medium sized version of the image hosted on your server."
}
}
},
"formats": {
"type": "string",
"enum": [
"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",
"Government publication",
"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",
"Microform",
"Object",
"Periodical",
"Periodical/Journal, magazine, other",
"Periodical/Newspaper",
"Photograph",
"Poster, chart, other",
"Printed music",
"Published",
"Sheet music",
"Sound",
"Sound/Interview, lecture, talk",
"Sound/Other sound",
"Sound/Recorded music",
"Thesis",
"Unpublished",
"Video",
"Video/Captioned"
]
},
"holding": {
"type": "object",
"description": "A container element for information about a copy of this work held by a particular organisation (library, archive, etc).",
"properties": {
"nuc": {
"type": "string",
"description": "The NUC symbol of an organisation with a copy of this work."
},
"contributor": {
"type": "string",
"description": "The Trove API URL to the Contributor who owns this holding."
},
"name": {
"type": "string",
"description": "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."
},
"library": {
"type": "string",
"description": "In future, this will be the API access point to look up more information about this organisation."
},
"url": {
"type": "object",
"description": "The best available link is shown.",
"properties": {
"type": {
"type": "string",
"enum": [
"deepLink",
"homepage",
"catalogue"
],
"description": "“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"
},
"value": {
"type": "string",
"description": "The url."
}
}
},
"callNumber": {
"description": "The institution’s call number for their copy of the work.",
"type": "array",
"items": {
"type": "object",
"properties": {
"localIdentifier": {
"type": "string",
"description": "Also provided if available. From Libraries Australia MARC records, this is extracted from 850$b."
},
"value": {
"type": "string",
"description": "The call number."
}
}
}
}
}
},
"identifier": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"url",
"isbn",
"ismn",
"issn",
"control number"
],
"description": "The type of the link"
},
"linktype": {
"type": "string",
"enum": [
"fulltext",
"restricted",
"subscription",
"unknown",
"notonline",
"thumbnail",
"viewcopy",
"searchable resource",
"metadata record",
"mediated"
],
"description": "Describes the type of content available at the url, for type='url' identifiers"
},
"url": {
"type": "string",
"description": "Depending on the linktype: The best known link to this work is included automatically in the brief record (if available); or A link to access this work through a particular organisation’s subscription; or A link to a thumbnail-sized image representing this item (if available)"
},
"linktext": {
"type": "string",
"description": "Link label, for type='url' identifiers"
},
"nuc": {
"type": "string",
"description": "The NUC symbol for the organisation that has the subscription, for linktype='subscription' identifiers."
},
"library": {
"type": "string",
"description": "In future will be the API access point for more information about the organisation that has the subscription."
},
"source": {
"type": "string",
"description": "The source of the identifier, for for type='control number' identifiers"
},
"value": {
"type": "string",
"description": "The value of the identifier. Will vary depending on the type and linktype properties."
}
}
},
"isPartOf": {
"type": "object",
"description": "A related resource in which the described resource is physically or logically included, e.g. a photograph or manuscript collection. For articles, the journal or periodical the article belongs to (if known)",
"properties": {
"value": {
"type": "string",
"description": "The related resource."
},
"url": {
"type": "string",
"description": "The Trove API URL to the related resource."
},
"type": {
"type": "string",
"description": "The type of related resource (e.g. series)."
}
}
},
"itemCount": {
"type": "object",
"description": "Generic object representing a structure with a count and an optional level attribute (e.g. work -> tagCount)",
"properties": {
"level": {
"type": "string",
"enum": [
"work",
"version"
],
"description": "The record level that encapsulates the counted items (either 'work' or 'version')."
},
"value": {
"type": "integer",
"description": "The count."
}
}
},
"language": {
"type": "object",
"description": "The language(s) the item is available in",
"properties": {
"value": {
"type": "string",
"description": "Language name or code of the item"
},
"type": {
"type": "string",
"description": "Language code or standard used to describe the item"
}
}
},
"list": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Trove list id."
},
"url": {
"type": "string",
"description": "A URL to retrieve more information about this list using the Trove API."
},
"lastupdated": {
"type": "string",
"description": "When the list was most recently added/edited (UTC timezone)."
},
"by": {
"type": "string",
"description": "The username of the person who created the list"
},
"troveUrl": {
"type": "string",
"description": "A link to view this list in the Trove web interface."
},
"title": {
"type": "string",
"description": "The name of the list. List names are not unique. Display them in conjunction with the list creator’s username."
},
"description": {
"type": "string",
"description": "Brief record (truncated to 120 characters); Full record (full value)."
},
"creator": {
"type": "string",
"description": "The username of the person who created the list. Anonymous lists are not allowed."
},
"listItemCount": {
"type": "integer",
"description": "The number of items in the list."
},
"identifier": {
"$ref": "#/$defs/identifier",
"description": "A link to a thumbnail image for the list."
},
"date": {
"type": "object",
"properties": {
"created": {
"type": "string",
"description": "When the record was created (UTC timezone)."
},
"lastupdated": {
"type": "string",
"description": "When the record was last changed (UTC timezone)."
}
}
},
"relevance": {
"$ref": "#/$defs/relevance"
},
"tagCount": {
"$ref": "#/$defs/itemCount",
"description": "The number of tags on this list."
},
"commentCount": {
"$ref": "#/$defs/itemCount",
"description": "The number of comments on this list."
},
"snippet": {
"type": "array",
"items": {
"type": "string"
},
"description": "A small amount of article text containing one or more of the search terms. The matching term/s are enclosed in a element."
},
"tag": {
"type": "array",
"items": {
"$ref": "#/$defs/tag"
},
"description": "A public tag added to the work. There may be more than one tag element."
},
"comment": {
"type": "array",
"items": {
"$ref": "#/$defs/comment"
},
"description": "A public comment on this list. There may be more than one comment element."
},
"listItem": {
"type": "array",
"items": {
"$ref": "#/$defs/listItem"
},
"description": "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": {
"type": "object",
"properties": {
"note": {
"type": "string",
"description": "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."
},
"work": {
"$ref": "#/$defs/work",
"description": "A brief record for a work that belongs to this list."
},
"article": {
"$ref": "#/$defs/article",
"description": "A brief record for a digitised newspaper article that belongs to this list."
},
"externalWebsite": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The name of the webpage."
},
"identifier": {
"type": "array",
"items": {
"$ref": "#/$defs/identifier"
},
"description": "The URL of the webpage."
},
"relevance": {
"$ref": "#/$defs/relevance"
}
},
"description": "Information about a link to page outside of Trove that has been included in this list."
},
"people": {
"$ref": "#/$defs/people",
"description": "A very brief record for a person or organisation that belongs to this list."
},
"deleted": {
"type": "object",
"description": "Indicator to show whether the item has been recently deleted from Trove",
"properties": {
"deleted": {
"type": "string",
"description": "The status of the linked record ('deleted')."
},
"value": {
"type": "string",
"description": "The reason the linked record is not available ('The resource described by this item has been deleted from Trove')."
}
}
},
"culturallySensitive": {
"type": "string",
"description": "An indicator of cultural sensitivity, particularly in respect to First Australians."
},
"firstAustralians": {
"type": "string",
"description": "Whether the item pertains to First Australians."
}
}
},
"people": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for this person/organisation."
},
"url": {
"type": "string",
"description": "A link to view this article in the Trove API."
},
"troveUrl": {
"type": "string",
"description": "A link to view this article in the Trove web interface."
},
"type": {
"type": "string",
"enum": [
"person",
"corporatebody",
"family"
]
},
"relevance": {
"$ref": "#/$defs/relevance"
},
"primaryName": {
"type": "string",
"description": "The person/organisation's primary name with, life dates (where applicable)"
},
"primaryDisplayName": {
"type": "string",
"description": "The person/organisation's primary name without life dates"
},
"alternateName": {
"type": "array",
"items": {
"type": "string"
},
"description": "Other name(s) that the person/organisation's is/are known by, with life dates (where applicable)"
},
"alternateDisplayName": {
"type": "array",
"items": {
"type": "string"
},
"description": "Other name(s) that the person/organisation's is/are known by, without life dates"
},
"identifier": {
"type": "array",
"items": {
"$ref": "#/$defs/identifier"
},
"description": "Additional identifiers for the person/organisation."
},
"disambiguation": {
"type": "boolean",
"description": "Disambiguation information for a person or organisation, to help distinguish people or organisations with the same or similar name"
},
"disambiguationName": {
"type": "array",
"description": "Disambiguation names and relation (e.g. 'is not')",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The related disambiguation name."
},
"url": {
"type": "string",
"description": "A link to the related person/organisation record."
},
"reltype": {
"type": "string",
"description": "The type of relationship between the two person/organisation records (e.g. may refer to, is not, etc)."
},
"reldesc": {
"type": "string",
"description": "More information about the relationship between the records."
}
}
}
},
"title": {
"type": "array",
"description": "Title associated with the person or organization including post-nominals and titles of status to show the awards and honours a person has (not available for organisations)",
"items": {
"type": "string"
}
},
"occupation": {
"type": "array",
"description": "One or more occupations describing the person (not available for organisations)",
"items": {
"type": "string"
}
},
"contributor": {
"type": "array",
"description": "The name of the contributor of this person or organisation record to Trove",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Trove contributor id"
},
"nuc": {
"type": "string",
"description": "The Trove contributor Nuc. Nuc (id) of the contributor of the person or organisation record to Trove"
},
"name": {
"type": "string",
"description": "The Trove contributor name. Name of the contributor of the person or organisation record to Trove"
},
"url": {
"type": "string",
"description": "The Trove contributor Url. A link to access the person or organisation record through the contributing organisation’s external website"
}
}
}
},
"biography": {
"type": "array",
"description": "A written account of the persons life or brief history of the organisation. Some Trove people and organisation records include multiple biographies contributed by various Trove partners/contributors",
"items": {
"type": "object",
"properties": {
"contributor": {
"type": "string",
"description": "The Trove contributor name. Name of the contributor of the person or organisation biography to Trove"
},
"contributorId": {
"type": "string",
"description": "The Trove contributorId. Id of the contributor of the person or organisation biography to Trove"
},
"id": {
"type": "string",
"description": "The URL id for the biography. URL identifier for the person or organization biography on the contributors website"
},
"biography": {
"type": "string",
"description": "Container element for the biography record for each person or organization biography contributed to Trove"
}
}
}
},
"record": {
"type": "array",
"description": "Container element for a Dublin Core or EAC-CPF 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.",
"items": {
"$ref": "#/$defs/record"
}
},
"tagCount": {
"type": "integer",
"description": "The number of public tags this person/organisation is in."
},
"commentCount": {
"type": "integer",
"description": "The number of public comments this person/organisation has."
},
"listCount": {
"type": "integer",
"description": "The number of public lists this person/organisation is in."
},
"tag": {
"type": "array",
"items": {
"$ref": "#/$defs/tag"
}
},
"comment": {
"type": "array",
"items": {
"$ref": "#/$defs/comment"
}
},
"list": {
"type": "array",
"items": {
"$ref": "#/$defs/list"
}
},
"culturallySensitive": {
"type": "string",
"description": "An indicator of cultural sensitivity, particularly in respect to First Australians."
},
"firstAustralians": {
"type": "string",
"description": "Whether the item pertains to First Australians."
}
}
},
"record": {
"type": "object",
"properties": {
"header": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "Unique identifier number or value for contributors for each record contributed to Trove"
},
"datestamp": {
"type": "string",
"description": "Datestamp for each record indicating the date of creation, modification or deletion of the record in Trove"
},
"setSpec": {
"type": "string",
"description": "Optional unique value for contributors to group records contributed to Trove as a set"
}
}
},
"metadata": {
"type": "object",
"properties": {
"dc": {
"$ref": "#/$defs/dcRecord"
},
"eac-cpf": {
"type": "object",
"additionalProperties": true,
"description": "The EAC-CPF record, processed into a structure compatible with the OpenAPI specification. See https://eac.staatsbibliothek-berlin.de/ for details of the EAC-CPF schema."
},
"rawXml": {
"type": "string",
"description": "When the \"raweaccpf\" Include option has been selected, this field will contain the original, unprocessed and unformatted EAC-CPF record that corresponds to the above processed eac-cpf element. Applicable categories: people."
}
}
},
"metadataSource": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The name of the organisation or aggregating service who contributed this record to Trove (e.g. Libraries Australia)."
},
"type": {
"type": "string",
"description": "The NUC symbol of the organisation who contributed this this record to Trove."
}
},
"description": "A related resource from which the described resource is derived, for example the print book from which an image was scanned."
}
}
},
"relevance": {
"type": "object",
"properties": {
"score": {
"type": "number",
"description": "A numeric representation of how relevant this record is to the search. This number can be compared to other search results in this category, but not to results from other categories."
},
"value": {
"type": "string",
"enum": [
"very relevant",
"likely to be relevant",
"may have relevance",
"limited relevance",
"vaguely relevant"
],
"description": "How relevant the record is to the search"
}
}
},
"spatial": {
"type": "object",
"description": "The spatial topic of the item. e.g. the location a photograph was taken",
"properties": {
"value": {
"type": "string",
"description": "Geographic place name or code for the item"
},
"scheme": {
"type": "string",
"description": "Geographic place code or standard used to describe the item"
}
}
},
"tag": {
"type": "object",
"properties": {
"lastupdated": {
"type": "string",
"description": "When the tag was added (UTC timezone)."
},
"value": {
"type": "string",
"description": "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)."
}
}
},
"version": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A string of internal Trove ids for any records that make up this version."
},
"record": {
"type": "array",
"description": "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.",
"items": {
"$ref": "#/$defs/record"
}
},
"type": {
"type": "array",
"items": {
"$ref": "#/$defs/formats"
},
"description": "The format of this version. There may be more than one type element."
},
"issued": {
"type": "array",
"items": {
"type": "string"
},
"description": "The date this version was issued/published/created. Either YYYY or YYYY-MM or YYYY-MM-DD."
},
"holdingsCount": {
"type": "integer",
"description": "The number of institutions (libraries, archives, etc) who have or control a copy of this work."
},
"tagCount": {
"description": "The number of public tags on this version (not including tags placed at the work level).",
"$ref": "#/$defs/itemCount"
},
"commentCount": {
"description": "The number of public comments on this version (not including comments placed at the work level).",
"$ref": "#/$defs/itemCount"
},
"tag": {
"type": "array",
"items": {
"$ref": "#/$defs/tag"
},
"description": "A public tag added to the version. There may be more than one tag element. Tags can also be added to a version (the version/tag element)."
},
"comment": {
"type": "array",
"items": {
"$ref": "#/$defs/comment"
},
"description": "A public comment added to the version. There may be more than one comment element. Comments can also be added to a version (the version/comment element)."
},
"identifier": {
"type": "array",
"items": {
"$ref": "#/$defs/identifier"
},
"description": "Additional identifiers for the version."
},
"culturallySensitive": {
"type": "string",
"description": "An indicator of cultural sensitivity, particularly in respect to First Australians."
},
"firstAustralians": {
"type": "string",
"description": "Whether the item pertains to First Australians."
},
"holding": {
"type": "array",
"items": {
"$ref": "#/$defs/holding"
},
"description": "A container element for information about a copy of this version held by a particular organisation (library, archive, etc)."
}
}
},
"work": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Trove work id"
},
"url": {
"type": "string",
"description": "A link to view this article in the Trove API."
},
"troveUrl": {
"type": "string",
"description": "A link to view this article in the Trove web interface."
},
"title": {
"type": "string",
"description": "The title or name of the work."
},
"contributor": {
"type": "array",
"items": {
"type": "string"
},
"description": "The main creator of this work. Some works have multiple creators listed, others have only one even if multiple creators exist."
},
"issued": {
"type": "string",
"description": "The year/s this work was issued, created or published. May also include month and day. May be a range."
},
"type": {
"type": "array",
"items": {
"$ref": "#/$defs/formats"
},
"description": "The format of this work. There may be more than one type element."
},
"isPartOf": {
"type": "array",
"items": {
"$ref": "#/$defs/isPartOf"
},
"description": "For articles, the journal or periodical this article belongs to (if known). The url may include the API access point to get more information about this periodical e.g. /work/13110632."
},
"subject": {
"type": "array",
"items": {
"type": "string"
},
"description": "Subjects describe what a work is about."
},
"abstract": {
"type": "string",
"description": "A description, summary, abstract, or first few words of this work, if available."
},
"audience": {
"type": "array",
"items": {
"type": "string"
},
"description": "The target audience of the work"
},
"rights": {
"type": "array",
"items": {
"type": "string"
},
"description": "The terms of use of the work"
},
"format": {
"type": "array",
"items": {
"type": "string"
},
"description": "The physical format of the item"
},
"extent": {
"type": "string",
"description": "The extent of the work"
},
"spatial": {
"type": "array",
"description": "The spatial topic of the item. e.g. the location a photograph was taken",
"items": {
"$ref": "#/$defs/spatial"
}
},
"placeOfPublication": {
"type": "array",
"items": {
"type": "string"
},
"description": "The place of publication of this work"
},
"snippet": {
"type": "array",
"items": {
"type": "string"
},
"description": "A small amount of text containing one or more of the search terms. The matching term/s are enclosed in a element"
},
"tableOfContents": {
"type": "string",
"description": "A table of contents for this work, if available. Where possible, each item is listed on a separate line within the same tableOfContents element."
},
"language": {
"type": "array",
"items": {
"$ref": "#/$defs/language"
},
"description": "The language/s this work is available in. More than one language element may be present."
},
"wikipedia": {
"type": "string",
"description": "Links to any known associated wikipedia articles. Includes markup."
},
"hasCorrections": {
"type": "string",
"enum": [
"Y",
"N"
],
"description": "Does the work have any text corrections?"
},
"relevance": {
"$ref": "#/$defs/relevance"
},
"lastUpdated": {
"type": "string",
"description": "The date of the most recent text correction (UTC timezone)."
},
"holdingsCount": {
"type": "integer",
"description": "The number of organisations (libraries, archives, etc) who have a copy of this work."
},
"versionCount": {
"type": "integer",
"description": "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."
},
"tagCount": {
"type": "array",
"items": {
"$ref": "#/$defs/itemCount"
},
"description": "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."
},
"commentCount": {
"type": "array",
"items": {
"$ref": "#/$defs/itemCount"
},
"description": "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."
},
"listCount": {
"type": "integer",
"description": "The number of public lists this work is in."
},
"tag": {
"type": "array",
"items": {
"$ref": "#/$defs/tag"
},
"description": "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)."
},
"comment": {
"type": "array",
"items": {
"$ref": "#/$defs/comment"
},
"description": "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)."
},
"list": {
"type": "array",
"items": {
"$ref": "#/$defs/list"
},
"description": "The name of a public, user-created list this work belongs to. There may be more than one list element."
},
"identifier": {
"type": "array",
"items": {
"$ref": "#/$defs/identifier"
},
"description": "Additional identifiers for the work."
},
"culturallySensitive": {
"type": "string",
"description": "An indicator of cultural sensitivity, particularly in respect to First Australians."
},
"firstAustralians": {
"type": "string",
"description": "Whether the item pertains to First Australians."
},
"holding": {
"type": "array",
"items": {
"$ref": "#/$defs/holding"
},
"description": "A container element for information about a copy of this work held by a particular organisation (library, archive, etc)."
},
"version": {
"description": "A container element for a version/edition that is part of this work. Versions usually contain one record but can sometimes contain several.",
"type": "array",
"items": {
"$ref": "#/$defs/version"
}
}
}
}
}
}