Developer Information

API Overview

Our API is a set of methods based on restful ideas over HTTP. At this time it only supports the GET verb and responses are in JSON only.

The root uri for the current version is located at

https://collections.museumvictoria.com.au/api

Pagination

Requests that return a list of objects will by default display 40 objects per request, you can change this to any number up to 100 by using a ?perpage query string parameter.

You can also specify a page parameter to retrieve results from different pages via a ?page query string parameter.

Link Header

The actual pagination information is stored in the response headers. In order to allow easy traversing of data sets refer to the Link header to get the next page of objects in your request. E.g

Link: <https://collections.museumvictoria.com.au/api/items?perpage=40&page=3>; rel="next",<https://collections.museumvictoria.com.au/api/items?perpage=40>; rel="prev"

The total results and total pages is also stored in the response headers. E.g

Total-Results: 87366
Total-Pages: 2185

Response Envelope

In order to make debuging with the api easy, we have included a way to encapsulate all the data needed for a response in the body of the response without having to dive into the actual headers. In order to do this simply add the value ?envelope=true to the query string

Operations about Searches

GET

/api/search


Description

Search the collection. All parameters used should be UTF-8 URL-Encoded strings.

Example URL /api/search

Parameters
Parameter Description
query
(optional)

Specify a search term. Can contain one or more values. In order to add more terms repeat the query parameter as follows "query=coin&query=india"

Example values:
coin
india

sort
(optional)

The order in which to sort return results. Regardless of the value used the direction of the order is always descending. Default value is relevance if the query parameter is present, otherwise quality is used as the default value.

Valid values:
quality
The quality of the record based on how many fields and images a record may have.
relevance
The relevance of the record based on the search query. Only valid if the query parameter is used.
date
The date the record was last modified.
random
Results are returned in a random order.

Example values:
quality
relevance
date
random

mindatemodified
(optional)

Minimum date a record was modified in ISO 8601 UTC format. Records with a modified date greater than or equal to this value will be returned.

Example values:
2014-06-21T12:00:00Z

maxdatemodified
(optional)

Maximum date a record was modified in ISO 8601 UTC format. Records with a modified date less than or equal to this value will be returned.

Example values:
2015-11-06T00:00:00Z

hasimages
(optional)

Specify whether or not the returned records contain images. Parameter is considered a facet.

Example values:
yes
no

ondisplay
(optional)

Specify whether or not the returned records are on display. Parameter is considered a facet.

Example values:
yes
no

recordtype
(optional)

Type of record to return. Parameter is considered a facet.

Example values:
article
item
species
specimen

category
(optional)

Collection category of a record. Parameter is considered a facet.

Example values:
natural sciences
indigenous collections

collectingarea
(optional)

Collecting area of a record. Can contain one or more values. In order to add more terms repeat the query parameter as follows "collectingarea=ornithology&collectingarea=mammalogy". Parameter is considered a facet.

Example values:
ornithology
mammalogy

specimenscientificgroup
(optional)

Specimen scientific group of a record, will only return specimen records. Parameter is considered a facet.

Example values:
geology
invertebrate zoology

specimenscientificgroup
(optional)

Specimen scientific group of a record, will only return specimen records. Parameter is considered a facet.

Example values:
geology
invertebrate zoology

itemtype
(optional)

The general type of specimen or item, will only return specimen or item records. Parameter is considered a facet.

Example values:
object
specimen

speciestype
(optional)

The broad category a species may be considered to belong to, will only return species records. Parameter is considered a facet.

Example values:
snakes
birds

imagelicence
(optional)

The open access licences that are attributed to a records images. Can contain one or more values. In order to add more terms repeat the query parameter as follows "imagelicence=public+domain&imagelicence=cc+by". Parameter is considered a facet.

Example values:
public domain
cc by

articletype
(optional)

The type of article, will only return article records. Can contain one or more values. In order to add more terms repeat the query parameter as follows "articletype=party&articletype=physical+object". Parameter is considered a facet.

Example values:
party
physical object

displaylocation
(optional)

The display location at Museums Victoria venues for the record, will only return item or specimen records. Parameter is considered a facet.

Example values:
melbourne museum
scienceworks

keyword
(optional)

The keywords generally used to describe the record, sorta like tags. Keywords can come from a variety of other fields on records such as...
articles:
keywords
items:
keywords, audioVisualRecordingDetails, modelNames, archeologyActivity, archeologySpecificActivity, archeologyDecoration, numismaticsSeries, tradeLiteraturePrimarySubject, tradeLiteraturePublicationTypes, brands
species:
conservationStatuses, animalSubType
specimens:
keywords, expeditionNameExpeditionName.

Example values:
handcrafts
australian art

locality
(optional)

The general locality a record may be associated with. Locality can come from a variety of other fields on records such as...
articles:
localities
items:
locality, region, state, country, indigenousCulturesLocalities
species:
nationalParks
specimens:
locality, region, state, country, ocean, continent, district, town, nearestNamedPlace, tektitesLocalStrewnfield, tektitesGlobalStrewnfield.

Example values:
barossa valley
germany

collection
(optional)

The museum collection a record belongs to, will only return item or specimen records. Collection can come from a variety of other fields on records such as...
items:
collectionNames, discipline
specimens:
collectionNames, discipline.

Example values:
spencer collection
royal exhibition building collection

date
(optional)

The general date a record may be associated with, due to the variation in the way date is cataloged the string must be an exact match and is not parsed into a standardised date format, will only return item or specimen records. Collection can come from a variety of other fields on records such as...
items:
date, indigenousCulturesDate, indigenousCulturesDateCollected, archeologyManufactureDate, philatelyDateIssued, tradeLiteraturePublicationDate
specimens:
date.

Example values:
02 nov 1956
05/11/1908

culturalgroup
(optional)

The indigenous cultures cultural group a record may be associated with, will only return item records.

Example values:
woi wurrung
barapa barapa

classification
(optional)

The museum classification a record may belong to, will only return item and specimen records.

Example values:
boring apparatus
dust collecting equipment

name
(optional)

A person or companies name a record may be associated with. Name can come from a variety of other fields on records such as...
articles:
author.fullName
items:
association.name, indigenousCulturesPhotographer, indigenousCulturesAuthor, indigenousCulturesIllustrator, indigenousCulturesMaker, indigenousCulturesCollector, indigenousCulturesLetterTo, indigenousCulturesLetterFrom, brand.name, archeologyManufactureName, tradeLiteraturePrimaryName, artworkPublisher
species:
author.fullName
specimens:
association.name.

Example values:
Mrs Jane Burn
Senator George F. Pearce - Australian Government

technique
(optional)

The archeology technique used to create an object, will only return item records.

Example values:
caved bone
machine-made

denomination
(optional)

The numismatics denomination of a record, will only return item records.

Example values:
half crown
obol

habitat
(optional)

The habitat or whereToLook a species lives in, will only return species records.

Example values:
woodland
seagrass meadows

taxon
(optional)

The taxonName, kingdom, phylum, subphylum, superclass, class, subclass, superorder, order, suborder, infraorder, superfamily, family, subfamily, commonName, otherCommonNames an item, species or specimen may belong to.

Example values:
mammalia
Ornithorhynchus anatinus

typestatus
(optional)

The type status of a specimen, will only return specimen records.

Example values:
holotype
paratype

geotype
(optional)

The petrologyRockClass, petrologyRockGroup, mineralogyVariety, mineralogyGroup, mineralogyClass, meteoritesClass, meteoritesGroup, tektitesClassification, mineralogySpecies a specimen may belong to.

Example values:
agate
copper

museumlocation
(optional)

The gallery or venue a record may be on display at one of Museums Victoria's venues, will only return item and specimen records.

Example values:
immigration museum
bunjilaka - first peoples

article
(optional)

The title of an article a record may be associated with, will only return article, item and specimen records.

Example values:
immigration museum
bunjilaka - first peoples

article
(optional)

The title of an article a record may be associated with, will only return article, item and specimen records.

Example values:
arms collection
csirac games - a summary

speciesendemicity
(optional)

The endemicity of a species, will only return species records.

Example values:
introduced pest
native to australia

Valid response status codes
HTTP status code Name Reason
200 OK A bunch of things were able to be searched ok.

Operations about Articles

GET

/api/articles


Description

Returns a bunch of articles.

Example URL /api/articles

Valid response status codes
HTTP status code Name Reason
200 OK A bunch of articles were able to be retrieved ok.
Sample Response
[
  {
    "recordType": "article",
    "licence": {
      "name": "Attribution 4.0 International",
      "shortName": "CC BY",
      "uri": "https://creativecommons.org/licenses/by/4.0"
    },
    "dateModified": "2016-10-02T07:37:00Z",
    "title": "The Battle of the Somme, 1916",
    "keywords": [
      "Australian Army",
      "Australians at war",
      "Commemorations",
      "World War I, 1914-1918"
    ],
    "localities": [
      "France",
      "Belgium"
    ],
    "content": "<p><em><strong>'We live in a world of Somme mud. We sleep in it, work in it, fight in it, wade in it and many of us die in it.</strong>'</em> Private Edward Francis Lynch, 45 Battalion, 4th Division AIF, 1916. </p>\n<p>The Battle of the Somme (Somme Offensive) saw the allied forces of Australia, Britain and France push forward against the German Imperial Force in a series of battles that inched the Allies north over the summer and autumn of 1916. From July until November, a mere 10 kilometres of ground was gained at a cost never before seen in the history of warfare. </p>\n<p>For Australian soldiers who had recently been in the Middle East, the first sight of the green farmlands of France was a relief. As they moved closer to the front, however, the bitter reality of battle on the Western Front became clear. With the approach of colder weather life became even harder, and those who endured the Somme of 1916 remember near-freezing weather and plains of deep mud. Troops on either side battled to supply their front line with food, munitions and medical treatments &#8211; meanwhile the mud and trench warfare meant simple tasks of communication became deathly gambits. Some of the most dangerous roles on the front included message runners, ammunition and water suppliers, and stretcher bearers. Men moving along the tops of trenches or venturing into no-man&#8217;s land were vulnerable to mass shelling and machine-gun fire. </p>\n<p>Australia paid a terrible cost for its involvement at the Somme. After massive casualties north at Fromelles on 19-20 July (an unsuccessful attempt to draw German troops away from the Somme Offensive), fighting at Pozieres and Mouquet Farm from 23 July to 3 September cost the First, Second and Fourth Australian Divisions some 23,000 wounded and 6,800 killed. Losses by other nations were even higher. On the first day of the Somme Offensive, the British army suffered 57,470 casualties including 19, 240 deaths. German losses on that day were estimated at 4,000 casualties and 2,000 captured; in total Germany lost an estimated 650,000 men during the Offensive. </p>\n<p>These high loses were in part due to the rapid mechanisation of World War I weapons. At the beginning of World War I, Germany possessed 1,200 machine guns. By July 1916, and the Somme Offensive, 11,000 machine guns were trained at the Allied forces. Each side raced to create larger and heavier-class weapons, such as British tanks and 420mm heavy German guns. The power of these enormous weapons was almost useless as they could barely be dragged, by horse, men or rail, through the Somme mud. </p>\n<p>As the terrible costs of the Somme mounted, both sides made significant changes to their commanders, tactics and strategies. In many ways, the Battle marked a watershed in World War I.</p>\n<p>For tens of thousands of front-line soldiers, the Battle of the Somme was also a watershed. As the French landscape was destroyed, many soldiers poignantly captured what they saw in photographs. As a way to cope, and to communicate with loved ones back home, many Australians documented their experience through diaries, letters and souvenirs. The tone and detail of these changed as their war experience continued. </p>\n<p>Museum Victoria&#8217;s collection of Somme memorabilia is typified by personal items &#8211; especially those worn or carried through the war, or which document an individual war experience. While military censorship reigned strong and restricted what could be sent home during 1914-1918, these items allow a personal and moving insight into life in the Somme Offensive. For many, these battles would continue on, reaching the home front and civilian life in deep ways. </p>\n<p><strong>References</strong></p>\n<p>&#8216;Australians in War&#8217;, Australian War Memorial, London, website: <a href=\"http://www.awmlondon.gov.au/australians-in-wwi\">http://www.awmlondon.gov.au/australians-in-wwi</a> (accessed 20/01/2016) <br>&#8216;World War I 1914-1918&#8217;, Australian War Memorial, Canberra, website: <a href=\"https://www.awm.gov.au/atwar/\">https://www.awm.gov.au/atwar/</a> (accessed 20/01/2016)<br>Beaumont, J. (Ed.) (1995) <em>Australia&#8217;s War, 1914-1918</em>. St. Leonard&#8217;s, NSW: Allen &amp; Unwin. <br>Butler, J. (2013) <em>Kitty&#8217;s War</em>. Queensland: University of Queensland Press. <br>Carlyon, L. (2006) <em>The Great War</em>. Sydney: Pan Macmillan Australia. <br>Lynch, E. P. F. (2008) (2nd edn.) <em>Somme Mud</em>. Sydney: Random House. p.73.<br>Monash, General Sir J. (2009) <em>The Australian Victories in France 1918</em>. East Sussex: Naval &amp; Military Press. Vol. 1-2. <br>Mulcahy, G.P. (1916) 'WWI Diary of Corporal Gilbert Payne Mulcahy, Volume 1, Gallipoli and France'. Museum Victoria Military Collection, Object No: ST 037404. Entries dated 25/03/1916-26/03/1916. <br>The National Archives of Australia, WWI Service Records, Series B245. Various records. <br>The Public Records Office of Victoria, Soldier-Settler Records online. Website: <a href=\"http://soldiersettlement.prov.vic.gov.au/\">http://soldiersettlement.prov.vic.gov.au/</a> (accessed 20/02/2016) <br></p>",
    "contentSummary": "The Battle of the Somme (1st July - 18th November 1916) is acutely remembered as one of the most costly battles within one of the most destructive wars (World War I) of all time. As the Centenary approaches in 2016, the collection items held by Museum Victoria are highlighted, particularly relating to Australian service in France, Belgium and the homefront.",
    "types": [
      "Historical Narrative",
      "Text"
    ],
    "authors": [
      {
        "firstName": "Nina",
        "lastName": "Buchan",
        "fullName": "Nina K. Buchan",
        "biography": "Volunteer with the History & Technology Collections at Museums Victoria.",
        "profileImage": null
      }
    ],
    "contributors": [],
    "media": [
      {
        "alternativeText": "Devestated battlefield with shell holes and barren trees.",
        "large": {
          "width": 2382,
          "height": 1803,
          "uri": "https://collections.museumvictoria.com.au/content/media/27/717727-large.jpg",
          "size": 1091912
        },
        "medium": {
          "width": 1500,
          "height": 1135,
          "uri": "https://collections.museumvictoria.com.au/content/media/27/717727-medium.jpg",
          "size": 330733
        },
        "small": {
          "width": 661,
          "height": 500,
          "uri": "https://collections.museumvictoria.com.au/content/media/27/717727-small.jpg",
          "size": 66128
        },
        "thumbnail": {
          "width": 250,
          "height": 250,
          "uri": "https://collections.museumvictoria.com.au/content/media/27/717727-thumbnail.jpg",
          "size": 11860
        },
        "dateModified": "2016-11-09T23:39:00Z",
        "caption": "Photograph - 'Shattered Remains of Monquet Farm', France, World War I, Oct 1916",
        "creators": [],
        "sources": [
          "Museums Victoria"
        ],
        "credit": null,
        "rightsStatement": "Public Domain",
        "licence": {
          "name": "Public Domain Mark",
          "shortName": "Public Domain",
          "uri": "http://creativecommons.org/publicdomain/mark/1.0/"
        }
      }
    ],
    "yearWritten": null,
    "parentArticleId": null,
    "childArticleIds": [
      "articles/14945"
    ],
    "relatedArticleIds": [
      "articles/4591"
    ],
    "relatedItemIds": [
      "items/748888",
      "items/2032665",
      "items/2076733",
      "items/394514",
      "items/380309",
      "items/380307",
      "items/1225696",
      "items/381936",
      "items/1759718",
      "items/1243799",
      "items/1688992",
      "items/1800570",
      "items/387368",
      "items/387361",
      "items/387350",
      "items/1209594",
      "items/394876",
      "items/2102788",
      "items/1182767",
      "items/1707440",
      "items/1706428",
      "items/380301",
      "items/380302",
      "items/1958241",
      "items/1706332",
      "items/1706361",
      "items/1706350",
      "items/1706337",
      "items/1706327",
      "items/1706320",
      "items/1706349",
      "items/1706313",
      "items/1706312",
      "items/1706336",
      "items/1706367",
      "items/1706357",
      "items/1706368",
      "items/1706347",
      "items/1706370",
      "items/1706358",
      "items/1706346",
      "items/1706341",
      "items/1706373",
      "items/1706360",
      "items/1706366",
      "items/1706314",
      "items/1706335",
      "items/1706322",
      "items/1706359",
      "items/1706395",
      "items/1706372",
      "items/1706348",
      "items/1706352",
      "items/1706329",
      "items/1706385",
      "items/1706315",
      "items/1706339",
      "items/1706321",
      "items/1706328",
      "items/1706356",
      "items/1706317",
      "items/1706338",
      "items/1706318",
      "items/1705252",
      "items/1706325",
      "items/1706330",
      "items/1706364",
      "items/1706355",
      "items/1706369",
      "items/1706333",
      "items/1706362",
      "items/1706363",
      "items/1706343",
      "items/1706345",
      "items/1706323",
      "items/1706354",
      "items/1706452",
      "items/1706451",
      "items/1706450",
      "items/1707449",
      "items/1706376",
      "items/1706375",
      "items/1706365",
      "items/1706340",
      "items/1706331",
      "items/1706326",
      "items/1706316",
      "items/1706319",
      "items/1706351",
      "items/1706353",
      "items/1706469",
      "items/1706344",
      "items/1706342",
      "items/1706334",
      "items/1706371",
      "items/1706374",
      "items/1343979",
      "items/1182093",
      "items/380303",
      "items/1182092",
      "items/803345",
      "items/380306",
      "items/380305",
      "items/2010129",
      "items/381937",
      "items/1208865",
      "items/395981",
      "items/1958200",
      "items/390809",
      "items/390817",
      "items/387354",
      "items/394931",
      "items/1703731",
      "items/1703708",
      "items/1703719",
      "items/1703716",
      "items/1703740",
      "items/1703704",
      "items/1703703",
      "items/1703746",
      "items/1703710",
      "items/1703741",
      "items/1703732",
      "items/1703747",
      "items/1703742",
      "items/1703717",
      "items/1703729",
      "items/1703730",
      "items/1703743",
      "items/1703721",
      "items/1703718",
      "items/1703734",
      "items/1703745",
      "items/1703736",
      "items/1703722",
      "items/1703733",
      "items/1703738",
      "items/1703720",
      "items/1703706",
      "items/1703711",
      "items/1703701",
      "items/1703712",
      "items/1703705",
      "items/1703714",
      "items/1703070",
      "items/1703715",
      "items/1703698",
      "items/1207547",
      "items/390836",
      "items/1349565",
      "items/1703076",
      "items/1703080",
      "items/1703077",
      "items/1703713",
      "items/1703075",
      "items/1703071",
      "items/1703081",
      "items/1703078",
      "items/1703074",
      "items/1703079",
      "items/1950772",
      "items/1703744",
      "items/1703737",
      "items/1954958",
      "items/1954912",
      "items/1954862",
      "items/1954798",
      "items/1954791",
      "items/1954796",
      "items/1954789",
      "items/1954822",
      "items/1954821",
      "items/1954820",
      "items/1954787",
      "items/1700728",
      "items/1700715",
      "items/1700735",
      "items/1699643",
      "items/1700744",
      "items/1700747",
      "items/1700727",
      "items/380287",
      "items/400756",
      "items/1954799",
      "items/826201",
      "items/381893",
      "items/391053",
      "items/390761",
      "items/1703739",
      "items/1977239",
      "items/391117",
      "items/1211184",
      "items/370483"
    ],
    "relatedSpecimenIds": [],
    "id": "articles/14946"
  }
]

GET

/api/articles/{id}


Description

Returns a single article by Id.

Example URL /api/articles/14946

Parameters
Parameter Description
Id
(required)

Id of article to be retrieved.

Valid response status codes
HTTP status code Name Reason
200 OK The article was found and retrieved ok.
404 NotFound The article could not be found and probably does not exist.
Sample Response
{
  "recordType": "article",
  "licence": {
    "name": "Attribution 4.0 International",
    "shortName": "CC BY",
    "uri": "https://creativecommons.org/licenses/by/4.0"
  },
  "dateModified": "2016-10-02T07:37:00Z",
  "title": "The Battle of the Somme, 1916",
  "keywords": [
    "Australian Army",
    "Australians at war",
    "Commemorations",
    "World War I, 1914-1918"
  ],
  "localities": [
    "France",
    "Belgium"
  ],
  "content": "<p><em><strong>'We live in a world of Somme mud. We sleep in it, work in it, fight in it, wade in it and many of us die in it.</strong>'</em> Private Edward Francis Lynch, 45 Battalion, 4th Division AIF, 1916. </p>\n<p>The Battle of the Somme (Somme Offensive) saw the allied forces of Australia, Britain and France push forward against the German Imperial Force in a series of battles that inched the Allies north over the summer and autumn of 1916. From July until November, a mere 10 kilometres of ground was gained at a cost never before seen in the history of warfare. </p>\n<p>For Australian soldiers who had recently been in the Middle East, the first sight of the green farmlands of France was a relief. As they moved closer to the front, however, the bitter reality of battle on the Western Front became clear. With the approach of colder weather life became even harder, and those who endured the Somme of 1916 remember near-freezing weather and plains of deep mud. Troops on either side battled to supply their front line with food, munitions and medical treatments &#8211; meanwhile the mud and trench warfare meant simple tasks of communication became deathly gambits. Some of the most dangerous roles on the front included message runners, ammunition and water suppliers, and stretcher bearers. Men moving along the tops of trenches or venturing into no-man&#8217;s land were vulnerable to mass shelling and machine-gun fire. </p>\n<p>Australia paid a terrible cost for its involvement at the Somme. After massive casualties north at Fromelles on 19-20 July (an unsuccessful attempt to draw German troops away from the Somme Offensive), fighting at Pozieres and Mouquet Farm from 23 July to 3 September cost the First, Second and Fourth Australian Divisions some 23,000 wounded and 6,800 killed. Losses by other nations were even higher. On the first day of the Somme Offensive, the British army suffered 57,470 casualties including 19, 240 deaths. German losses on that day were estimated at 4,000 casualties and 2,000 captured; in total Germany lost an estimated 650,000 men during the Offensive. </p>\n<p>These high loses were in part due to the rapid mechanisation of World War I weapons. At the beginning of World War I, Germany possessed 1,200 machine guns. By July 1916, and the Somme Offensive, 11,000 machine guns were trained at the Allied forces. Each side raced to create larger and heavier-class weapons, such as British tanks and 420mm heavy German guns. The power of these enormous weapons was almost useless as they could barely be dragged, by horse, men or rail, through the Somme mud. </p>\n<p>As the terrible costs of the Somme mounted, both sides made significant changes to their commanders, tactics and strategies. In many ways, the Battle marked a watershed in World War I.</p>\n<p>For tens of thousands of front-line soldiers, the Battle of the Somme was also a watershed. As the French landscape was destroyed, many soldiers poignantly captured what they saw in photographs. As a way to cope, and to communicate with loved ones back home, many Australians documented their experience through diaries, letters and souvenirs. The tone and detail of these changed as their war experience continued. </p>\n<p>Museum Victoria&#8217;s collection of Somme memorabilia is typified by personal items &#8211; especially those worn or carried through the war, or which document an individual war experience. While military censorship reigned strong and restricted what could be sent home during 1914-1918, these items allow a personal and moving insight into life in the Somme Offensive. For many, these battles would continue on, reaching the home front and civilian life in deep ways. </p>\n<p><strong>References</strong></p>\n<p>&#8216;Australians in War&#8217;, Australian War Memorial, London, website: <a href=\"http://www.awmlondon.gov.au/australians-in-wwi\">http://www.awmlondon.gov.au/australians-in-wwi</a> (accessed 20/01/2016) <br>&#8216;World War I 1914-1918&#8217;, Australian War Memorial, Canberra, website: <a href=\"https://www.awm.gov.au/atwar/\">https://www.awm.gov.au/atwar/</a> (accessed 20/01/2016)<br>Beaumont, J. (Ed.) (1995) <em>Australia&#8217;s War, 1914-1918</em>. St. Leonard&#8217;s, NSW: Allen &amp; Unwin. <br>Butler, J. (2013) <em>Kitty&#8217;s War</em>. Queensland: University of Queensland Press. <br>Carlyon, L. (2006) <em>The Great War</em>. Sydney: Pan Macmillan Australia. <br>Lynch, E. P. F. (2008) (2nd edn.) <em>Somme Mud</em>. Sydney: Random House. p.73.<br>Monash, General Sir J. (2009) <em>The Australian Victories in France 1918</em>. East Sussex: Naval &amp; Military Press. Vol. 1-2. <br>Mulcahy, G.P. (1916) 'WWI Diary of Corporal Gilbert Payne Mulcahy, Volume 1, Gallipoli and France'. Museum Victoria Military Collection, Object No: ST 037404. Entries dated 25/03/1916-26/03/1916. <br>The National Archives of Australia, WWI Service Records, Series B245. Various records. <br>The Public Records Office of Victoria, Soldier-Settler Records online. Website: <a href=\"http://soldiersettlement.prov.vic.gov.au/\">http://soldiersettlement.prov.vic.gov.au/</a> (accessed 20/02/2016) <br></p>",
  "contentSummary": "The Battle of the Somme (1st July - 18th November 1916) is acutely remembered as one of the most costly battles within one of the most destructive wars (World War I) of all time. As the Centenary approaches in 2016, the collection items held by Museum Victoria are highlighted, particularly relating to Australian service in France, Belgium and the homefront.",
  "types": [
    "Historical Narrative",
    "Text"
  ],
  "authors": [
    {
      "firstName": "Nina",
      "lastName": "Buchan",
      "fullName": "Nina K. Buchan",
      "biography": "Volunteer with the History & Technology Collections at Museums Victoria.",
      "profileImage": null
    }
  ],
  "contributors": [],
  "media": [
    {
      "alternativeText": "Devestated battlefield with shell holes and barren trees.",
      "large": {
        "width": 2382,
        "height": 1803,
        "uri": "https://collections.museumvictoria.com.au/content/media/27/717727-large.jpg",
        "size": 1091912
      },
      "medium": {
        "width": 1500,
        "height": 1135,
        "uri": "https://collections.museumvictoria.com.au/content/media/27/717727-medium.jpg",
        "size": 330733
      },
      "small": {
        "width": 661,
        "height": 500,
        "uri": "https://collections.museumvictoria.com.au/content/media/27/717727-small.jpg",
        "size": 66128
      },
      "thumbnail": {
        "width": 250,
        "height": 250,
        "uri": "https://collections.museumvictoria.com.au/content/media/27/717727-thumbnail.jpg",
        "size": 11860
      },
      "dateModified": "2016-11-09T23:39:00Z",
      "caption": "Photograph - 'Shattered Remains of Monquet Farm', France, World War I, Oct 1916",
      "creators": [],
      "sources": [
        "Museums Victoria"
      ],
      "credit": null,
      "rightsStatement": "Public Domain",
      "licence": {
        "name": "Public Domain Mark",
        "shortName": "Public Domain",
        "uri": "http://creativecommons.org/publicdomain/mark/1.0/"
      }
    }
  ],
  "yearWritten": null,
  "parentArticleId": null,
  "childArticleIds": [
    "articles/14945"
  ],
  "relatedArticleIds": [
    "articles/4591"
  ],
  "relatedItemIds": [
    "items/748888",
    "items/2032665",
    "items/2076733",
    "items/394514",
    "items/380309",
    "items/380307",
    "items/1225696",
    "items/381936",
    "items/1759718",
    "items/1243799",
    "items/1688992",
    "items/1800570",
    "items/387368",
    "items/387361",
    "items/387350",
    "items/1209594",
    "items/394876",
    "items/2102788",
    "items/1182767",
    "items/1707440",
    "items/1706428",
    "items/380301",
    "items/380302",
    "items/1958241",
    "items/1706332",
    "items/1706361",
    "items/1706350",
    "items/1706337",
    "items/1706327",
    "items/1706320",
    "items/1706349",
    "items/1706313",
    "items/1706312",
    "items/1706336",
    "items/1706367",
    "items/1706357",
    "items/1706368",
    "items/1706347",
    "items/1706370",
    "items/1706358",
    "items/1706346",
    "items/1706341",
    "items/1706373",
    "items/1706360",
    "items/1706366",
    "items/1706314",
    "items/1706335",
    "items/1706322",
    "items/1706359",
    "items/1706395",
    "items/1706372",
    "items/1706348",
    "items/1706352",
    "items/1706329",
    "items/1706385",
    "items/1706315",
    "items/1706339",
    "items/1706321",
    "items/1706328",
    "items/1706356",
    "items/1706317",
    "items/1706338",
    "items/1706318",
    "items/1705252",
    "items/1706325",
    "items/1706330",
    "items/1706364",
    "items/1706355",
    "items/1706369",
    "items/1706333",
    "items/1706362",
    "items/1706363",
    "items/1706343",
    "items/1706345",
    "items/1706323",
    "items/1706354",
    "items/1706452",
    "items/1706451",
    "items/1706450",
    "items/1707449",
    "items/1706376",
    "items/1706375",
    "items/1706365",
    "items/1706340",
    "items/1706331",
    "items/1706326",
    "items/1706316",
    "items/1706319",
    "items/1706351",
    "items/1706353",
    "items/1706469",
    "items/1706344",
    "items/1706342",
    "items/1706334",
    "items/1706371",
    "items/1706374",
    "items/1343979",
    "items/1182093",
    "items/380303",
    "items/1182092",
    "items/803345",
    "items/380306",
    "items/380305",
    "items/2010129",
    "items/381937",
    "items/1208865",
    "items/395981",
    "items/1958200",
    "items/390809",
    "items/390817",
    "items/387354",
    "items/394931",
    "items/1703731",
    "items/1703708",
    "items/1703719",
    "items/1703716",
    "items/1703740",
    "items/1703704",
    "items/1703703",
    "items/1703746",
    "items/1703710",
    "items/1703741",
    "items/1703732",
    "items/1703747",
    "items/1703742",
    "items/1703717",
    "items/1703729",
    "items/1703730",
    "items/1703743",
    "items/1703721",
    "items/1703718",
    "items/1703734",
    "items/1703745",
    "items/1703736",
    "items/1703722",
    "items/1703733",
    "items/1703738",
    "items/1703720",
    "items/1703706",
    "items/1703711",
    "items/1703701",
    "items/1703712",
    "items/1703705",
    "items/1703714",
    "items/1703070",
    "items/1703715",
    "items/1703698",
    "items/1207547",
    "items/390836",
    "items/1349565",
    "items/1703076",
    "items/1703080",
    "items/1703077",
    "items/1703713",
    "items/1703075",
    "items/1703071",
    "items/1703081",
    "items/1703078",
    "items/1703074",
    "items/1703079",
    "items/1950772",
    "items/1703744",
    "items/1703737",
    "items/1954958",
    "items/1954912",
    "items/1954862",
    "items/1954798",
    "items/1954791",
    "items/1954796",
    "items/1954789",
    "items/1954822",
    "items/1954821",
    "items/1954820",
    "items/1954787",
    "items/1700728",
    "items/1700715",
    "items/1700735",
    "items/1699643",
    "items/1700744",
    "items/1700747",
    "items/1700727",
    "items/380287",
    "items/400756",
    "items/1954799",
    "items/826201",
    "items/381893",
    "items/391053",
    "items/390761",
    "items/1703739",
    "items/1977239",
    "items/391117",
    "items/1211184",
    "items/370483"
  ],
  "relatedSpecimenIds": [],
  "id": "articles/14946"
}

Operations about Items

GET

/api/items


Description

Returns a bunch of items.

Example URL /api/items

Valid response status codes
HTTP status code Name Reason
200 OK A bunch of items were able to be retrieved ok.
Sample Response
[
  {
    "recordType": "item",
    "comments": [],
    "licence": {
      "name": "Attribution 4.0 International",
      "shortName": "CC BY",
      "uri": "https://creativecommons.org/licenses/by/4.0"
    },
    "dateModified": "2015-08-14T02:05:00Z",
    "category": "History & Technology",
    "discipline": "Numismatics",
    "type": "Object",
    "registrationNumber": "NU 34194",
    "collectionNames": [
      "Napoleonic Medals"
    ],
    "collectingAreas": [
      "Public Life & Institutions"
    ],
    "classifications": [
      "Medals",
      "Commemorative",
      "Napoleonic"
    ],
    "objectName": "Medal - Vienna Captured, Napoleon Bonaparte (Emperor Napoleon I), France, 1805",
    "objectSummary": "Medal Prise de Vienne et de Presbourg, Vienna Captured, Issued by France,1805\nArtist: Bertrand Andrieu and Andre Galle\nMinted by Paris Mint",
    "physicalDescription": null,
    "inscription": null,
    "associations": [
      {
        "type": "Issued By",
        "name": "Napoleon Bonaparte",
        "date": "1805",
        "comments": "Date of event commemorated",
        "streetAddress": null,
        "locality": "Vienna",
        "region": null,
        "state": null,
        "country": "France"
      },
      {
        "type": "Artist",
        "name": "Bertrand Andrieu",
        "date": "1806",
        "comments": "Date of medal production",
        "streetAddress": null,
        "locality": null,
        "region": null,
        "state": null,
        "country": "France"
      },
      {
        "type": "Artist",
        "name": "Andre Galle",
        "date": "1806",
        "comments": "Date of medal production",
        "streetAddress": null,
        "locality": null,
        "region": null,
        "state": null,
        "country": "France"
      }
    ],
    "keywords": [
      "Napoleon Bonaparte"
    ],
    "significance": "\"the French took possession of the city without firing a shot. The main body of the French arrived at Vienna on the 12th, and were lodged in the suburbs, they entered the city on the 13th, when they found the inhabitants doing the duty of the military, who had totally evacuated it. Bonaparte entered Vienna on the 14th, and chose the imperial palace of Schoenbrunn for his residence. \n\nImmediately after the capture of the Austrian capital, the corps of Davoust was detached towards Presburg, which it took possession of, and from which place Davoust commenced a negotiation with the Archduke Palatine, the object of which was to free Napoleon from part of his opponents, by establishing the neutrality of Hungary. \" Laskey p. 102",
    "modelScale": null,
    "shape": "Round",
    "dimensions": [
      {
        "configuration": null,
        "dimensions": "38.5 g (Weight)",
        "comments": null
      }
    ],
    "references": "Chitty p.37\nLaskey LVII obverse by Andrieu",
    "bibliographies": [
      "[Book] Laskey, J. C. Medals Struck at the National Medal Mint by Order of Napoleon Bonaparte., 99-102 Pages"
    ],
    "modelNames": [],
    "brands": [],
    "relatedItemIds": [
      "items/55481"
    ],
    "relatedSpecimenIds": [],
    "relatedArticleIds": [],
    "relatedSpeciesIds": [],
    "media": [
      {
        "alternativeText": null,
        "large": {
          "width": 3000,
          "height": 3000,
          "uri": "https://collections.museumvictoria.com.au/content/media/30/641880-large.jpg",
          "size": 1774741
        },
        "medium": {
          "width": 1500,
          "height": 1500,
          "uri": "https://collections.museumvictoria.com.au/content/media/30/641880-medium.jpg",
          "size": 389556
        },
        "small": {
          "width": 500,
          "height": 500,
          "uri": "https://collections.museumvictoria.com.au/content/media/30/641880-small.jpg",
          "size": 47335
        },
        "thumbnail": {
          "width": 250,
          "height": 250,
          "uri": "https://collections.museumvictoria.com.au/content/media/30/641880-thumbnail.jpg",
          "size": 12680
        },
        "dateModified": "2016-11-10T03:33:00Z",
        "caption": "Medal - Vienna Captured, Napoleon Bonaparte (Emperor Napoleon I), France, 1805",
        "creators": [
          "Photographer: Justine Philip"
        ],
        "sources": [
          "Museums Victoria"
        ],
        "credit": null,
        "rightsStatement": "Copyright Museums Victoria / CC BY",
        "licence": {
          "name": "Attribution 4.0 International",
          "shortName": "CC BY",
          "uri": "https://creativecommons.org/licenses/by/4.0"
        }
      },
      {
        "alternativeText": null,
        "large": {
          "width": 3000,
          "height": 3000,
          "uri": "https://collections.museumvictoria.com.au/content/media/32/641882-large.jpg",
          "size": 1958932
        },
        "medium": {
          "width": 1500,
          "height": 1500,
          "uri": "https://collections.museumvictoria.com.au/content/media/32/641882-medium.jpg",
          "size": 434270
        },
        "small": {
          "width": 500,
          "height": 500,
          "uri": "https://collections.museumvictoria.com.au/content/media/32/641882-small.jpg",
          "size": 52521
        },
        "thumbnail": {
          "width": 250,
          "height": 250,
          "uri": "https://collections.museumvictoria.com.au/content/media/32/641882-thumbnail.jpg",
          "size": 13907
        },
        "dateModified": "2016-11-10T03:33:00Z",
        "caption": "Medal - Vienna Captured, Napoleon Bonaparte (Emperor Napoleon I), France, 1805",
        "creators": [
          "Photographer: Justine Philip"
        ],
        "sources": [
          "Museums Victoria"
        ],
        "credit": null,
        "rightsStatement": "Copyright Museums Victoria / CC BY",
        "licence": {
          "name": "Attribution 4.0 International",
          "shortName": "CC BY",
          "uri": "https://creativecommons.org/licenses/by/4.0"
        }
      }
    ],
    "acquisitionInformation": "Transfer from National Gallery of Victoria (NGV), 15/3/1976",
    "acknowledgement": null,
    "museumLocation": null,
    "archeologyContextNumber": null,
    "archeologySite": null,
    "archeologyDescription": null,
    "archeologyDistinguishingMarks": null,
    "archeologyActivity": null,
    "archeologySpecificActivity": null,
    "archeologyDecoration": null,
    "archeologyPattern": null,
    "archeologyColour": null,
    "archeologyMoulding": null,
    "archeologyPlacement": null,
    "archeologyForm": null,
    "archeologyShape": null,
    "archeologyManufactureName": null,
    "archeologyManufactureDate": null,
    "archeologyTechnique": null,
    "archeologyProvenance": null,
    "numismaticsDenomination": null,
    "numismaticsDateIssued": "1805 AD",
    "numismaticsSeries": "Napoleon Bonaparte",
    "numismaticsMaterial": "Bronze",
    "numismaticsAxis": "12",
    "numismaticsEdgeDescription": "Plain",
    "numismaticsObverseDescription": "Laureate head of Napoleon facing right, around, NAPOLEON EMP. ET ROI.; on neck truncation in small lettering,  ANDRIEU F.",
    "numismaticsReverseDescription": "Napoleon as Hercules standing full to the front resting on his club, his head laureate, lion's skin over his shoulder; on each side on their knees, two females draped (the Genii of the cities of Vienna and Presbourg) are presenting the keys of their respective cities to the conqueror; their heads are turretted and veiled; in exergue, PRISE DE VIENNE / ET DE PRESBOURG / MDCCCV.; around rim,  DENON D. GALLE F.",
    "philatelyColour": null,
    "philatelyDenomination": null,
    "philatelyImprint": null,
    "philatelyIssue": null,
    "philatelyDateIssued": null,
    "philatelyForm": null,
    "philatelyOverprint": null,
    "philatelyGibbonsNumber": null,
    "isdFormat": null,
    "isdLanguage": null,
    "isdDescriptionOfContent": null,
    "isdPeopleDepicted": null,
    "audioVisualRecordingDetails": null,
    "audioVisualContentSummaries": [],
    "tradeLiteratureNumberofPages": null,
    "tradeLiteraturePageSizeFormat": null,
    "tradeLiteratureCoverTitle": null,
    "tradeLiteraturePrimarySubject": null,
    "tradeLiteraturePublicationDate": null,
    "tradeLiteratureIllustrationTypes": null,
    "tradeLiteraturePrintingTypes": null,
    "tradeLiteraturePublicationTypes": [],
    "tradeLiteraturePrimaryRole": null,
    "tradeLiteraturePrimaryName": null,
    "indigenousCulturesLocalities": [],
    "indigenousCulturesCulturalGroups": [],
    "indigenousCulturesMedium": null,
    "indigenousCulturesDescription": null,
    "indigenousCulturesLocalName": null,
    "indigenousCulturesPhotographer": null,
    "indigenousCulturesAuthor": null,
    "indigenousCulturesIllustrator": null,
    "indigenousCulturesMaker": null,
    "indigenousCulturesDate": null,
    "indigenousCulturesCollector": null,
    "indigenousCulturesDateCollected": null,
    "indigenousCulturesIndividualsIdentified": null,
    "indigenousCulturesTitle": null,
    "indigenousCulturesSheets": null,
    "indigenousCulturesPages": null,
    "indigenousCulturesLetterTo": null,
    "indigenousCulturesLetterFrom": null,
    "artworkMedium": null,
    "artworkTechnique": null,
    "artworkSupport": null,
    "artworkPlateNumber": null,
    "artworkDrawingNumber": null,
    "artworkState": null,
    "artworkPublisher": null,
    "artworkPrimaryInscriptions": null,
    "artworkSecondaryInscriptions": null,
    "artworkTertiaryInscriptions": null,
    "typeStatus": null,
    "identifiedBy": null,
    "dateIdentified": null,
    "qualifier": null,
    "qualifierRank": "None",
    "taxonomy": null,
    "id": "items/61573"
  }
]

GET

/api/items/{id}


Description

Returns a single item by Id.

Example URL /api/items/61573

Parameters
Parameter Description
Id
(required)

Id of item to be retrieved

Valid response status codes
HTTP status code Name Reason
200 OK The item was found and retrieved ok.
404 NotFound The item could not be found and probably does not exist.
Sample Response
{
  "recordType": "item",
  "comments": [],
  "licence": {
    "name": "Attribution 4.0 International",
    "shortName": "CC BY",
    "uri": "https://creativecommons.org/licenses/by/4.0"
  },
  "dateModified": "2015-08-14T02:05:00Z",
  "category": "History & Technology",
  "discipline": "Numismatics",
  "type": "Object",
  "registrationNumber": "NU 34194",
  "collectionNames": [
    "Napoleonic Medals"
  ],
  "collectingAreas": [
    "Public Life & Institutions"
  ],
  "classifications": [
    "Medals",
    "Commemorative",
    "Napoleonic"
  ],
  "objectName": "Medal - Vienna Captured, Napoleon Bonaparte (Emperor Napoleon I), France, 1805",
  "objectSummary": "Medal Prise de Vienne et de Presbourg, Vienna Captured, Issued by France,1805\nArtist: Bertrand Andrieu and Andre Galle\nMinted by Paris Mint",
  "physicalDescription": null,
  "inscription": null,
  "associations": [
    {
      "type": "Issued By",
      "name": "Napoleon Bonaparte",
      "date": "1805",
      "comments": "Date of event commemorated",
      "streetAddress": null,
      "locality": "Vienna",
      "region": null,
      "state": null,
      "country": "France"
    },
    {
      "type": "Artist",
      "name": "Bertrand Andrieu",
      "date": "1806",
      "comments": "Date of medal production",
      "streetAddress": null,
      "locality": null,
      "region": null,
      "state": null,
      "country": "France"
    },
    {
      "type": "Artist",
      "name": "Andre Galle",
      "date": "1806",
      "comments": "Date of medal production",
      "streetAddress": null,
      "locality": null,
      "region": null,
      "state": null,
      "country": "France"
    }
  ],
  "keywords": [
    "Napoleon Bonaparte"
  ],
  "significance": "\"the French took possession of the city without firing a shot. The main body of the French arrived at Vienna on the 12th, and were lodged in the suburbs, they entered the city on the 13th, when they found the inhabitants doing the duty of the military, who had totally evacuated it. Bonaparte entered Vienna on the 14th, and chose the imperial palace of Schoenbrunn for his residence. \n\nImmediately after the capture of the Austrian capital, the corps of Davoust was detached towards Presburg, which it took possession of, and from which place Davoust commenced a negotiation with the Archduke Palatine, the object of which was to free Napoleon from part of his opponents, by establishing the neutrality of Hungary. \" Laskey p. 102",
  "modelScale": null,
  "shape": "Round",
  "dimensions": [
    {
      "configuration": null,
      "dimensions": "38.5 g (Weight)",
      "comments": null
    }
  ],
  "references": "Chitty p.37\nLaskey LVII obverse by Andrieu",
  "bibliographies": [
    "[Book] Laskey, J. C. Medals Struck at the National Medal Mint by Order of Napoleon Bonaparte., 99-102 Pages"
  ],
  "modelNames": [],
  "brands": [],
  "relatedItemIds": [
    "items/55481"
  ],
  "relatedSpecimenIds": [],
  "relatedArticleIds": [],
  "relatedSpeciesIds": [],
  "media": [
    {
      "alternativeText": null,
      "large": {
        "width": 3000,
        "height": 3000,
        "uri": "https://collections.museumvictoria.com.au/content/media/30/641880-large.jpg",
        "size": 1774741
      },
      "medium": {
        "width": 1500,
        "height": 1500,
        "uri": "https://collections.museumvictoria.com.au/content/media/30/641880-medium.jpg",
        "size": 389556
      },
      "small": {
        "width": 500,
        "height": 500,
        "uri": "https://collections.museumvictoria.com.au/content/media/30/641880-small.jpg",
        "size": 47335
      },
      "thumbnail": {
        "width": 250,
        "height": 250,
        "uri": "https://collections.museumvictoria.com.au/content/media/30/641880-thumbnail.jpg",
        "size": 12680
      },
      "dateModified": "2016-11-10T03:33:00Z",
      "caption": "Medal - Vienna Captured, Napoleon Bonaparte (Emperor Napoleon I), France, 1805",
      "creators": [
        "Photographer: Justine Philip"
      ],
      "sources": [
        "Museums Victoria"
      ],
      "credit": null,
      "rightsStatement": "Copyright Museums Victoria / CC BY",
      "licence": {
        "name": "Attribution 4.0 International",
        "shortName": "CC BY",
        "uri": "https://creativecommons.org/licenses/by/4.0"
      }
    },
    {
      "alternativeText": null,
      "large": {
        "width": 3000,
        "height": 3000,
        "uri": "https://collections.museumvictoria.com.au/content/media/32/641882-large.jpg",
        "size": 1958932
      },
      "medium": {
        "width": 1500,
        "height": 1500,
        "uri": "https://collections.museumvictoria.com.au/content/media/32/641882-medium.jpg",
        "size": 434270
      },
      "small": {
        "width": 500,
        "height": 500,
        "uri": "https://collections.museumvictoria.com.au/content/media/32/641882-small.jpg",
        "size": 52521
      },
      "thumbnail": {
        "width": 250,
        "height": 250,
        "uri": "https://collections.museumvictoria.com.au/content/media/32/641882-thumbnail.jpg",
        "size": 13907
      },
      "dateModified": "2016-11-10T03:33:00Z",
      "caption": "Medal - Vienna Captured, Napoleon Bonaparte (Emperor Napoleon I), France, 1805",
      "creators": [
        "Photographer: Justine Philip"
      ],
      "sources": [
        "Museums Victoria"
      ],
      "credit": null,
      "rightsStatement": "Copyright Museums Victoria / CC BY",
      "licence": {
        "name": "Attribution 4.0 International",
        "shortName": "CC BY",
        "uri": "https://creativecommons.org/licenses/by/4.0"
      }
    }
  ],
  "acquisitionInformation": "Transfer from National Gallery of Victoria (NGV), 15/3/1976",
  "acknowledgement": null,
  "museumLocation": null,
  "archeologyContextNumber": null,
  "archeologySite": null,
  "archeologyDescription": null,
  "archeologyDistinguishingMarks": null,
  "archeologyActivity": null,
  "archeologySpecificActivity": null,
  "archeologyDecoration": null,
  "archeologyPattern": null,
  "archeologyColour": null,
  "archeologyMoulding": null,
  "archeologyPlacement": null,
  "archeologyForm": null,
  "archeologyShape": null,
  "archeologyManufactureName": null,
  "archeologyManufactureDate": null,
  "archeologyTechnique": null,
  "archeologyProvenance": null,
  "numismaticsDenomination": null,
  "numismaticsDateIssued": "1805 AD",
  "numismaticsSeries": "Napoleon Bonaparte",
  "numismaticsMaterial": "Bronze",
  "numismaticsAxis": "12",
  "numismaticsEdgeDescription": "Plain",
  "numismaticsObverseDescription": "Laureate head of Napoleon facing right, around, NAPOLEON EMP. ET ROI.; on neck truncation in small lettering,  ANDRIEU F.",
  "numismaticsReverseDescription": "Napoleon as Hercules standing full to the front resting on his club, his head laureate, lion's skin over his shoulder; on each side on their knees, two females draped (the Genii of the cities of Vienna and Presbourg) are presenting the keys of their respective cities to the conqueror; their heads are turretted and veiled; in exergue, PRISE DE VIENNE / ET DE PRESBOURG / MDCCCV.; around rim,  DENON D. GALLE F.",
  "philatelyColour": null,
  "philatelyDenomination": null,
  "philatelyImprint": null,
  "philatelyIssue": null,
  "philatelyDateIssued": null,
  "philatelyForm": null,
  "philatelyOverprint": null,
  "philatelyGibbonsNumber": null,
  "isdFormat": null,
  "isdLanguage": null,
  "isdDescriptionOfContent": null,
  "isdPeopleDepicted": null,
  "audioVisualRecordingDetails": null,
  "audioVisualContentSummaries": [],
  "tradeLiteratureNumberofPages": null,
  "tradeLiteraturePageSizeFormat": null,
  "tradeLiteratureCoverTitle": null,
  "tradeLiteraturePrimarySubject": null,
  "tradeLiteraturePublicationDate": null,
  "tradeLiteratureIllustrationTypes": null,
  "tradeLiteraturePrintingTypes": null,
  "tradeLiteraturePublicationTypes": [],
  "tradeLiteraturePrimaryRole": null,
  "tradeLiteraturePrimaryName": null,
  "indigenousCulturesLocalities": [],
  "indigenousCulturesCulturalGroups": [],
  "indigenousCulturesMedium": null,
  "indigenousCulturesDescription": null,
  "indigenousCulturesLocalName": null,
  "indigenousCulturesPhotographer": null,
  "indigenousCulturesAuthor": null,
  "indigenousCulturesIllustrator": null,
  "indigenousCulturesMaker": null,
  "indigenousCulturesDate": null,
  "indigenousCulturesCollector": null,
  "indigenousCulturesDateCollected": null,
  "indigenousCulturesIndividualsIdentified": null,
  "indigenousCulturesTitle": null,
  "indigenousCulturesSheets": null,
  "indigenousCulturesPages": null,
  "indigenousCulturesLetterTo": null,
  "indigenousCulturesLetterFrom": null,
  "artworkMedium": null,
  "artworkTechnique": null,
  "artworkSupport": null,
  "artworkPlateNumber": null,
  "artworkDrawingNumber": null,
  "artworkState": null,
  "artworkPublisher": null,
  "artworkPrimaryInscriptions": null,
  "artworkSecondaryInscriptions": null,
  "artworkTertiaryInscriptions": null,
  "typeStatus": null,
  "identifiedBy": null,
  "dateIdentified": null,
  "qualifier": null,
  "qualifierRank": "None",
  "taxonomy": null,
  "id": "items/61573"
}

Operations about Species

GET

/api/species


Description

Returns a bunch of species.

Example URL /api/species

Valid response status codes
HTTP status code Name Reason
200 OK A bunch of species were able to be retrieved ok.
Sample Response
[
  {
    "recordType": "species",
    "licence": {
      "name": "Attribution 4.0 International",
      "shortName": "CC BY",
      "uri": "https://creativecommons.org/licenses/by/4.0"
    },
    "dateModified": "2016-11-06T22:49:00Z",
    "animalType": "Seaweeds & seagrasses",
    "animalSubType": "Seagrasses",
    "colours": [],
    "maximumSize": "7 cm",
    "habitats": [
      "Seagrass meadows",
      "Soft substrates"
    ],
    "whereToLook": [],
    "whenActive": [],
    "nationalParks": [],
    "diet": "Photosynthetic - sunlight",
    "dietCategories": [],
    "fastFact": null,
    "habitat": "Sandy and muddy substrates in sheltered embayments and estuaries, to depth of 23 m.",
    "distribution": "Southern Australia.",
    "biology": "This seaweed can form large beds across the sea floor.",
    "generalDescription": "Paddle-shaped leaves occurring often in pairs with obvious cross-veins on surface arise from delicate stems (petioles). Stem arises from buried runner (stolon). Flowers arise on branches between leaf pairs. Green to almost transparent leaves with white stem. Up to 7 cm (leaf) long.",
    "briefId": "Paddle-shaped leaf, stem arises from root runners.",
    "hazards": null,
    "endemicity": "Native to Australia",
    "commercial": "No",
    "conservationStatuses": [
      "DSE Advisory List Not listed",
      "EPBC Act 1999 Not listed",
      "IUCN Red List Not listed"
    ],
    "web": null,
    "plants": [],
    "flightStart": null,
    "flightEnd": null,
    "depths": [
      "Shallow (1-30 m)"
    ],
    "waterColumnLocations": [
      "On or near sea floor"
    ],
    "relatedItemIds": [],
    "relatedSpecimenIds": [],
    "relatedArticleIds": [
      "articles/14374"
    ],
    "relatedSpeciesIds": [],
    "authors": [
      {
        "firstName": "Jacqui",
        "lastName": "Pocklington",
        "fullName": "Dr Jacqui Pocklington",
        "biography": "Research Associate with expertise in algal taxonomy.",
        "profileImage": {
          "alternativeText": "Woman standing on deck of boat.",
          "large": {
            "width": 251,
            "height": 251,
            "uri": "https://collections.museumvictoria.com.au/content/media/35/652185-large.jpg",
            "size": 24026
          },
          "medium": {
            "width": 251,
            "height": 251,
            "uri": "https://collections.museumvictoria.com.au/content/media/35/652185-medium.jpg",
            "size": 18620
          },
          "small": {
            "width": 500,
            "height": 500,
            "uri": "https://collections.museumvictoria.com.au/content/media/35/652185-small.jpg",
            "size": 40090
          },
          "thumbnail": {
            "width": 250,
            "height": 250,
            "uri": "https://collections.museumvictoria.com.au/content/media/35/652185-thumbnail.jpg",
            "size": 16569
          },
          "dateModified": "2016-11-10T03:22:00Z",
          "caption": "Jacqui Pocklington thumbnail for webuse",
          "creators": [
            "Unknown photographer"
          ],
          "sources": [
            "Museums Victoria"
          ],
          "credit": null,
          "rightsStatement": "Copyright Museums Victoria / CC BY",
          "licence": {
            "name": "Attribution 4.0 International",
            "shortName": "CC BY",
            "uri": "https://creativecommons.org/licenses/by/4.0"
          }
        }
      }
    ],
    "yearWritten": null,
    "media": [
      {
        "alternativeText": "Silent footage of Paddle Weed, <em>Halophila australis</em>.",
        "uri": "https://youtu.be/IMW5JlYadMU",
        "videoId": "IMW5JlYadMU",
        "thumbnail": {
          "width": 667,
          "height": 500,
          "uri": "https://collections.museumvictoria.com.au/content/media/33/828133-thumbnail.jpg",
          "size": 12863
        },
        "small": {
          "width": 667,
          "height": 500,
          "uri": "https://collections.museumvictoria.com.au/content/media/33/828133-medium.jpg",
          "size": 51877
        },
        "dateModified": "2016-11-10T03:58:00Z",
        "caption": "Silent footage of Paddle Weed, <em>Halophila australis</em>.",
        "creators": [
          "Videographer: Mark Norman"
        ],
        "sources": [
          "Museums Victoria"
        ],
        "credit": "We are working to make our content more accessible. If you require an alternate format to enjoy this video, please contact us.",
        "rightsStatement": "Copyright Museums Victoria / CC BY",
        "licence": {
          "name": "Attribution 4.0 International",
          "shortName": "CC BY",
          "uri": "https://creativecommons.org/licenses/by/4.0"
        }
      }
    ],
    "taxonomy": {
      "kingdom": "Plantae",
      "phylum": "Charophyta",
      "subphylum": null,
      "superclass": null,
      "class": "Equisetopsida",
      "subclass": "Magnoliidae",
      "superorder": "Lilianae",
      "order": "Alismatales",
      "suborder": null,
      "infraorder": null,
      "superfamily": null,
      "family": "Hydrocharitaceae",
      "subfamily": null,
      "genus": "Halophila",
      "subgenus": null,
      "species": "australis",
      "subspecies": null,
      "author": "Doty & B.C.Stone",
      "code": "ICZN",
      "taxonName": "Halophila australis",
      "commonName": "Paddle Weed",
      "otherCommonNames": []
    },
    "id": "species/14255"
  }
]

GET

/api/species/{id}


Description

Returns a single species by Id.

Example URL /api/species/14255

Parameters
Parameter Description
Id
(required)

Id of species to be retrieved

Valid response status codes
HTTP status code Name Reason
200 OK The species was found and retrieved ok.
404 NotFound The species could not be found and probably does not exist.
Sample Response
{
  "recordType": "species",
  "licence": {
    "name": "Attribution 4.0 International",
    "shortName": "CC BY",
    "uri": "https://creativecommons.org/licenses/by/4.0"
  },
  "dateModified": "2016-11-06T22:49:00Z",
  "animalType": "Seaweeds & seagrasses",
  "animalSubType": "Seagrasses",
  "colours": [],
  "maximumSize": "7 cm",
  "habitats": [
    "Seagrass meadows",
    "Soft substrates"
  ],
  "whereToLook": [],
  "whenActive": [],
  "nationalParks": [],
  "diet": "Photosynthetic - sunlight",
  "dietCategories": [],
  "fastFact": null,
  "habitat": "Sandy and muddy substrates in sheltered embayments and estuaries, to depth of 23 m.",
  "distribution": "Southern Australia.",
  "biology": "This seaweed can form large beds across the sea floor.",
  "generalDescription": "Paddle-shaped leaves occurring often in pairs with obvious cross-veins on surface arise from delicate stems (petioles). Stem arises from buried runner (stolon). Flowers arise on branches between leaf pairs. Green to almost transparent leaves with white stem. Up to 7 cm (leaf) long.",
  "briefId": "Paddle-shaped leaf, stem arises from root runners.",
  "hazards": null,
  "endemicity": "Native to Australia",
  "commercial": "No",
  "conservationStatuses": [
    "DSE Advisory List Not listed",
    "EPBC Act 1999 Not listed",
    "IUCN Red List Not listed"
  ],
  "web": null,
  "plants": [],
  "flightStart": null,
  "flightEnd": null,
  "depths": [
    "Shallow (1-30 m)"
  ],
  "waterColumnLocations": [
    "On or near sea floor"
  ],
  "relatedItemIds": [],
  "relatedSpecimenIds": [],
  "relatedArticleIds": [
    "articles/14374"
  ],
  "relatedSpeciesIds": [],
  "authors": [
    {
      "firstName": "Jacqui",
      "lastName": "Pocklington",
      "fullName": "Dr Jacqui Pocklington",
      "biography": "Research Associate with expertise in algal taxonomy.",
      "profileImage": {
        "alternativeText": "Woman standing on deck of boat.",
        "large": {
          "width": 251,
          "height": 251,
          "uri": "https://collections.museumvictoria.com.au/content/media/35/652185-large.jpg",
          "size": 24026
        },
        "medium": {
          "width": 251,
          "height": 251,
          "uri": "https://collections.museumvictoria.com.au/content/media/35/652185-medium.jpg",
          "size": 18620
        },
        "small": {
          "width": 500,
          "height": 500,
          "uri": "https://collections.museumvictoria.com.au/content/media/35/652185-small.jpg",
          "size": 40090
        },
        "thumbnail": {
          "width": 250,
          "height": 250,
          "uri": "https://collections.museumvictoria.com.au/content/media/35/652185-thumbnail.jpg",
          "size": 16569
        },
        "dateModified": "2016-11-10T03:22:00Z",
        "caption": "Jacqui Pocklington thumbnail for webuse",
        "creators": [
          "Unknown photographer"
        ],
        "sources": [
          "Museums Victoria"
        ],
        "credit": null,
        "rightsStatement": "Copyright Museums Victoria / CC BY",
        "licence": {
          "name": "Attribution 4.0 International",
          "shortName": "CC BY",
          "uri": "https://creativecommons.org/licenses/by/4.0"
        }
      }
    }
  ],
  "yearWritten": null,
  "media": [
    {
      "alternativeText": "Silent footage of Paddle Weed, <em>Halophila australis</em>.",
      "uri": "https://youtu.be/IMW5JlYadMU",
      "videoId": "IMW5JlYadMU",
      "thumbnail": {
        "width": 667,
        "height": 500,
        "uri": "https://collections.museumvictoria.com.au/content/media/33/828133-thumbnail.jpg",
        "size": 12863
      },
      "small": {
        "width": 667,
        "height": 500,
        "uri": "https://collections.museumvictoria.com.au/content/media/33/828133-medium.jpg",
        "size": 51877
      },
      "dateModified": "2016-11-10T03:58:00Z",
      "caption": "Silent footage of Paddle Weed, <em>Halophila australis</em>.",
      "creators": [
        "Videographer: Mark Norman"
      ],
      "sources": [
        "Museums Victoria"
      ],
      "credit": "We are working to make our content more accessible. If you require an alternate format to enjoy this video, please contact us.",
      "rightsStatement": "Copyright Museums Victoria / CC BY",
      "licence": {
        "name": "Attribution 4.0 International",
        "shortName": "CC BY",
        "uri": "https://creativecommons.org/licenses/by/4.0"
      }
    }
  ],
  "taxonomy": {
    "kingdom": "Plantae",
    "phylum": "Charophyta",
    "subphylum": null,
    "superclass": null,
    "class": "Equisetopsida",
    "subclass": "Magnoliidae",
    "superorder": "Lilianae",
    "order": "Alismatales",
    "suborder": null,
    "infraorder": null,
    "superfamily": null,
    "family": "Hydrocharitaceae",
    "subfamily": null,
    "genus": "Halophila",
    "subgenus": null,
    "species": "australis",
    "subspecies": null,
    "author": "Doty & B.C.Stone",
    "code": "ICZN",
    "taxonName": "Halophila australis",
    "commonName": "Paddle Weed",
    "otherCommonNames": []
  },
  "id": "species/14255"
}

Operations about Specimens

GET

/api/specimens


Description

Returns a bunch of specimens.

Example URL /api/specimens

Valid response status codes
HTTP status code Name Reason
200 OK A bunch of specimens were able to be retrieved ok.
Sample Response
[
  {
    "recordType": "specimen",
    "licence": {
      "name": "Public Domain Dedication",
      "shortName": "Public Domain",
      "uri": "https://creativecommons.org/publicdomain/zero/1.0/"
    },
    "dateModified": "2016-07-13T01:33:00Z",
    "category": "Natural Sciences",
    "scientificGroup": "Invertebrate Zoology",
    "discipline": "Entomology",
    "registrationNumber": "LEP 35654",
    "collectionNames": [
      "A.N. Burns Collection"
    ],
    "type": "Specimen",
    "classifications": [],
    "objectName": null,
    "objectSummary": null,
    "isdDescriptionOfContent": null,
    "significance": null,
    "keywords": [],
    "collectingAreas": [
      "Entomology and Arachnology"
    ],
    "associations": [],
    "relatedItemIds": [],
    "relatedSpecimenIds": [],
    "relatedArticleIds": [],
    "relatedSpeciesIds": [],
    "acquisitionInformation": null,
    "acknowledgement": null,
    "museumLocation": null,
    "media": [],
    "numberOfSpecimens": "1",
    "clutchSize": null,
    "sex": "Male",
    "stageOrAge": null,
    "storages": [
      {
        "nature": null,
        "form": "pinned",
        "fixativeTreatment": null,
        "medium": null
      }
    ],
    "typeStatus": null,
    "identifiedBy": null,
    "dateIdentified": "23/02/2009",
    "qualifier": null,
    "qualifierRank": "None",
    "taxonomy": {
      "kingdom": "Animalia",
      "phylum": "Arthropoda",
      "subphylum": "Uniramia",
      "superclass": null,
      "class": "Insecta",
      "subclass": null,
      "superorder": null,
      "order": "Lepidoptera",
      "suborder": null,
      "infraorder": null,
      "superfamily": null,
      "family": "Lycaenidae",
      "subfamily": null,
      "genus": "Psychonotis",
      "subgenus": null,
      "species": "caelius",
      "subspecies": "taygetus",
      "author": "(Macleay, 1866)",
      "code": "ICZN",
      "taxonName": "Psychonotis caelius taygetus",
      "commonName": "Small Green-banded Blue",
      "otherCommonNames": [
        "small green-banded blue"
      ]
    },
    "collectionEvent": {
      "expeditionName": null,
      "collectionEventCode": null,
      "samplingMethod": null,
      "dateVisitedFrom": null,
      "dateVisitedTo": null,
      "depthTo": null,
      "depthFrom": null,
      "collectedBy": null
    },
    "collectionSite": {
      "siteCode": null,
      "ocean": null,
      "continent": null,
      "country": "Australia",
      "state": "Queensland",
      "district": null,
      "town": null,
      "nearestNamedPlace": "Mackay",
      "preciseLocation": "near Mackay",
      "minimumElevation": null,
      "maximumElevation": null,
      "latitudes": [
        "-21.15"
      ],
      "longitudes": [
        "149.18"
      ],
      "geodeticDatum": "WGS84",
      "siteRadius": null,
      "georeferenceBy": null,
      "georeferenceDate": null,
      "georeferenceProtocol": null,
      "georeferenceSource": "Gazetteer",
      "geologyEra": null,
      "geologyPeriod": null,
      "geologyEpoch": null,
      "geologyStage": null,
      "geologyGroup": null,
      "geologyFormation": null,
      "geologyMember": null,
      "geologyRockType": null
    },
    "palaeontologyDateCollectedFrom": null,
    "palaeontologyDateCollectedTo": null,
    "mineralogySpecies": null,
    "mineralogyVariety": null,
    "mineralogyGroup": null,
    "mineralogyClass": null,
    "mineralogyAssociatedMatrix": null,
    "mineralogyType": null,
    "mineralogyTypeOfType": null,
    "meteoritesName": null,
    "meteoritesClass": null,
    "meteoritesGroup": null,
    "meteoritesType": null,
    "meteoritesMinerals": null,
    "meteoritesSpecimenWeight": null,
    "meteoritesTotalWeight": null,
    "meteoritesDateFell": null,
    "meteoritesDateFound": null,
    "tektitesName": null,
    "tektitesClassification": null,
    "tektitesShape": null,
    "tektitesLocalStrewnfield": null,
    "tektitesGlobalStrewnfield": null,
    "petrologyRockClass": null,
    "petrologyRockGroup": null,
    "petrologyRockName": null,
    "petrologyRockDescription": null,
    "petrologyMineralsPresent": null,
    "id": "specimens/872930"
  }
]

GET

/api/specimens/{id}


Description

Returns a single specimen by Id.

Example URL /api/specimens/872930

Parameters
Parameter Description
Id
(required)

Id of specimen to be retrieved

Valid response status codes
HTTP status code Name Reason
200 OK The specimen was found and retrieved ok.
404 NotFound The specimen could not be found and probably does not exist.
Sample Response
{
  "recordType": "specimen",
  "licence": {
    "name": "Public Domain Dedication",
    "shortName": "Public Domain",
    "uri": "https://creativecommons.org/publicdomain/zero/1.0/"
  },
  "dateModified": "2016-07-13T01:33:00Z",
  "category": "Natural Sciences",
  "scientificGroup": "Invertebrate Zoology",
  "discipline": "Entomology",
  "registrationNumber": "LEP 35654",
  "collectionNames": [
    "A.N. Burns Collection"
  ],
  "type": "Specimen",
  "classifications": [],
  "objectName": null,
  "objectSummary": null,
  "isdDescriptionOfContent": null,
  "significance": null,
  "keywords": [],
  "collectingAreas": [
    "Entomology and Arachnology"
  ],
  "associations": [],
  "relatedItemIds": [],
  "relatedSpecimenIds": [],
  "relatedArticleIds": [],
  "relatedSpeciesIds": [],
  "acquisitionInformation": null,
  "acknowledgement": null,
  "museumLocation": null,
  "media": [],
  "numberOfSpecimens": "1",
  "clutchSize": null,
  "sex": "Male",
  "stageOrAge": null,
  "storages": [
    {
      "nature": null,
      "form": "pinned",
      "fixativeTreatment": null,
      "medium": null
    }
  ],
  "typeStatus": null,
  "identifiedBy": null,
  "dateIdentified": "23/02/2009",
  "qualifier": null,
  "qualifierRank": "None",
  "taxonomy": {
    "kingdom": "Animalia",
    "phylum": "Arthropoda",
    "subphylum": "Uniramia",
    "superclass": null,
    "class": "Insecta",
    "subclass": null,
    "superorder": null,
    "order": "Lepidoptera",
    "suborder": null,
    "infraorder": null,
    "superfamily": null,
    "family": "Lycaenidae",
    "subfamily": null,
    "genus": "Psychonotis",
    "subgenus": null,
    "species": "caelius",
    "subspecies": "taygetus",
    "author": "(Macleay, 1866)",
    "code": "ICZN",
    "taxonName": "Psychonotis caelius taygetus",
    "commonName": "Small Green-banded Blue",
    "otherCommonNames": [
      "small green-banded blue"
    ]
  },
  "collectionEvent": {
    "expeditionName": null,
    "collectionEventCode": null,
    "samplingMethod": null,
    "dateVisitedFrom": null,
    "dateVisitedTo": null,
    "depthTo": null,
    "depthFrom": null,
    "collectedBy": null
  },
  "collectionSite": {
    "siteCode": null,
    "ocean": null,
    "continent": null,
    "country": "Australia",
    "state": "Queensland",
    "district": null,
    "town": null,
    "nearestNamedPlace": "Mackay",
    "preciseLocation": "near Mackay",
    "minimumElevation": null,
    "maximumElevation": null,
    "latitudes": [
      "-21.15"
    ],
    "longitudes": [
      "149.18"
    ],
    "geodeticDatum": "WGS84",
    "siteRadius": null,
    "georeferenceBy": null,
    "georeferenceDate": null,
    "georeferenceProtocol": null,
    "georeferenceSource": "Gazetteer",
    "geologyEra": null,
    "geologyPeriod": null,
    "geologyEpoch": null,
    "geologyStage": null,
    "geologyGroup": null,
    "geologyFormation": null,
    "geologyMember": null,
    "geologyRockType": null
  },
  "palaeontologyDateCollectedFrom": null,
  "palaeontologyDateCollectedTo": null,
  "mineralogySpecies": null,
  "mineralogyVariety": null,
  "mineralogyGroup": null,
  "mineralogyClass": null,
  "mineralogyAssociatedMatrix": null,
  "mineralogyType": null,
  "mineralogyTypeOfType": null,
  "meteoritesName": null,
  "meteoritesClass": null,
  "meteoritesGroup": null,
  "meteoritesType": null,
  "meteoritesMinerals": null,
  "meteoritesSpecimenWeight": null,
  "meteoritesTotalWeight": null,
  "meteoritesDateFell": null,
  "meteoritesDateFound": null,
  "tektitesName": null,
  "tektitesClassification": null,
  "tektitesShape": null,
  "tektitesLocalStrewnfield": null,
  "tektitesGlobalStrewnfield": null,
  "petrologyRockClass": null,
  "petrologyRockGroup": null,
  "petrologyRockName": null,
  "petrologyRockDescription": null,
  "petrologyMineralsPresent": null,
  "id": "specimens/872930"
}