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.museumsvictoria.com.au/api

Client Requirements

The only requirement is that the client must supply a User-Agent header in the API request. This can be blank if need be, but it must be present.

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.museumsvictoria.com.au/api/items?perpage=40&page=3>; rel="next",<https://collections.museumsvictoria.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
first peoples
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, firstPeoplesLocalities
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, firstPeoplesDate, firstPeoplesDateCollected, archeologyManufactureDate, philatelyDateIssued, tradeLiteraturePublicationDate
specimens:
date.

Example values:
02 nov 1956
05/11/1908
culturalgroup
(optional)

The First Peoples 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, firstPeoplesPhotographer, firstPeoplesAuthor, firstPeoplesIllustrator, firstPeoplesMaker, firstPeoplesCollector, firstPeoplesLetterTo, firstPeoplesLetterFrom, 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": "2020-06-10T23:04:00Z",
    "title": "Apple QuickTime Software 1991 - A Technical Description",
    "displayTitle": "Apple QuickTime Software 1991 - A Technical Description",
    "keywords": [
      "Apple (computer)",
      "Computers",
      "Computing"
    ],
    "localities": [],
    "content": "<p>QuickTime is software whose functions include the recording, editing and playback of sound and video. It can also be used to convert such media to and from formats.</p>\n<p>QuickTime supports the incorporation of movies and audio into files created using applications such as Microsoft Word or in pages displayed by web browsers. </p>\n<p>QuickTime is software whose file format or architecture:</p>\n<p>1. Functions as a multimedia container for tracks that store data that is in the form of video, audio, animation, images or text in one or more of a wide range of supported file formats.<br>2. Allows the data to be edited as time-based data using tools that are provided, that is, Cut, Copy and Paste functions, the merging of separate audio and video tracks, and the placing of video tracks on a virtual canvas with options of cropping and rotation.<br>3. Supports the saving and exporting (encoding) of the file in a range of file formats (as supported by compatible codecs [coder-decoders]) and thus facilitates a range of file conversions, including for video capable iPod, Apple TV and iPhone.<br>4. Allows the data to be 'played', that is displayed on screen (or in the case of an audio track, 'heard') for the duration of the stored tracks.</p>\n<p>Applications such as Final Cut Pro, iMovie and Premiere Pro allow the users to display, edit, copy and paste QuickTime movies in a similar way to working with text and graphics. They commonly incorporate additional tools for working with the data, such as video transitions and audio filters, that are more extensive than those provided by QuickTime itself.</p>\n<p>Examples of software from Apple that take advantage of QuickTime include iTunes and iMovie.</p>\n<p>QuickTime has both Macintosh and Windows versions.</p>\n<p>The system software for the&nbsp;iPod touch and the iPhone also includes QuickTime. QuickTime for Macintosh and Windows includes a basic player application called (understandably) QuickTime Player. In earlier versions, QuickTime Player included editing and export functions that are only accessible in later versions on payment of a fee for a licence key. The unlocked version is known as QuickTime Pro. Other applications have access to the full QuickTime feature set whether or not a Pro licence has been purchased.</p>\n<p>QuickTime was released on 2 December 1991, although it was first demonstrated publicly at a World Wide Developers' Conference in May 1991. There an astonished audience saw QuickTime's lead developer use QuickTime to play Apple's famous 1984 TV commercial 'Blade Runner' (used at the release of the first Macintosh) on a Macintosh, at the time, an astounding technological breakthrough. At first, the screen size and number of frames per second of a movie played with QuickTime was extremely limited, but this was progressively improved over a number of years until QuickTime was able to sustain playing video full screen at 25 frames per second, that is, at a size and rate comparable with that of analogue video tape.</p>\n<p>A person from Melbourne who tested QuickTime in 1991 prior to its release described it as 'an astounding technological breakthrough'. Additionally it was well in advance of Microsoft's competing technology, Video for Windows, which did not appear until November 1992. He was working for an advertising agency at the time. He became excited about QuickTime's animation and sound capabilities, its ability to compress video files, and its use of a virtual reality panoramic photo format. The video editing software of the time required the total resources of a dedicated computer and thus was not transportable. Additionally it was very expensive; only large institutions could afford such software. QuickTime was cheap and stored on a single CD. He was thus able to use QuickTime at home and share in the raising of a family. He says that it still took many years before video was able to become full screen and 25 frames per second.</p>\n<p>In launching a video production business in 1992, the donor purchased a QuickTime Developers Kit as well as the following items:</p>\n<ul>\n<li>Quadra 900 with 2 monitors, and CD ROM reader with SCSI cable \n</li><li>Videospigot for converting analog video into digital \n</li><li>Adobe Premiere 1 for video editing</li></ul>\n<p>The Compact Disks were read by an Apple CD Reader attached to the donor's Quadra 900 by a SCSI cable. Apple was one of the first companies to release a CD Reader, which it did in 1991. This facilitated the delivery of larger sized files of the new multi-megabyte applications including the QuickTime files on these CDs.</p>\n<p>&nbsp;</p>",
    "contentSummary": null,
    "types": [
      "Historical Narrative"
    ],
    "authors": [
      {
        "firstName": "Noel",
        "lastName": "Jackling",
        "fullName": "Mr Noel S. Jackling",
        "biography": "Volunteer with the Apple Company Collection at Museums Victoria.",
        "profileImage": null
      },
      {
        "firstName": "Stephen",
        "lastName": "Withers",
        "fullName": "Mr Stephen Withers",
        "biography": null,
        "profileImage": null
      }
    ],
    "contributors": [],
    "media": [
      {
        "type": "image",
        "alternativeText": null,
        "large": {
          "width": 2694,
          "height": 2048,
          "uri": "https://collections.museumsvictoria.com.au/content/media/21/237771-large.jpg",
          "size": 611226
        },
        "medium": {
          "width": 1500,
          "height": 1140,
          "uri": "https://collections.museumsvictoria.com.au/content/media/21/237771-medium.jpg",
          "size": 151347
        },
        "small": {
          "width": 658,
          "height": 500,
          "uri": "https://collections.museumsvictoria.com.au/content/media/21/237771-small.jpg",
          "size": 40856
        },
        "thumbnail": {
          "width": 250,
          "height": 250,
          "uri": "https://collections.museumsvictoria.com.au/content/media/21/237771-thumbnail.jpg",
          "size": 11243
        },
        "id": "media/237771",
        "dateModified": "2016-11-10T03:36:00Z",
        "caption": "Apple Macintosh Software -  QuickTime Developers Kit",
        "creators": [],
        "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": "2009",
    "parentArticleId": null,
    "childArticleIds": [],
    "relatedArticleIds": [],
    "relatedItemIds": [
      "items/1241375",
      "items/1231822"
    ],
    "relatedSpecimenIds": [],
    "id": "articles/2780"
  }
]

GET

/api/articles/{id}


Description

Returns a single article by Id.

Example URL /api/articles/2780

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": "2020-06-10T23:04:00Z",
  "title": "Apple QuickTime Software 1991 - A Technical Description",
  "displayTitle": "Apple QuickTime Software 1991 - A Technical Description",
  "keywords": [
    "Apple (computer)",
    "Computers",
    "Computing"
  ],
  "localities": [],
  "content": "<p>QuickTime is software whose functions include the recording, editing and playback of sound and video. It can also be used to convert such media to and from formats.</p>\n<p>QuickTime supports the incorporation of movies and audio into files created using applications such as Microsoft Word or in pages displayed by web browsers. </p>\n<p>QuickTime is software whose file format or architecture:</p>\n<p>1. Functions as a multimedia container for tracks that store data that is in the form of video, audio, animation, images or text in one or more of a wide range of supported file formats.<br>2. Allows the data to be edited as time-based data using tools that are provided, that is, Cut, Copy and Paste functions, the merging of separate audio and video tracks, and the placing of video tracks on a virtual canvas with options of cropping and rotation.<br>3. Supports the saving and exporting (encoding) of the file in a range of file formats (as supported by compatible codecs [coder-decoders]) and thus facilitates a range of file conversions, including for video capable iPod, Apple TV and iPhone.<br>4. Allows the data to be 'played', that is displayed on screen (or in the case of an audio track, 'heard') for the duration of the stored tracks.</p>\n<p>Applications such as Final Cut Pro, iMovie and Premiere Pro allow the users to display, edit, copy and paste QuickTime movies in a similar way to working with text and graphics. They commonly incorporate additional tools for working with the data, such as video transitions and audio filters, that are more extensive than those provided by QuickTime itself.</p>\n<p>Examples of software from Apple that take advantage of QuickTime include iTunes and iMovie.</p>\n<p>QuickTime has both Macintosh and Windows versions.</p>\n<p>The system software for the&nbsp;iPod touch and the iPhone also includes QuickTime. QuickTime for Macintosh and Windows includes a basic player application called (understandably) QuickTime Player. In earlier versions, QuickTime Player included editing and export functions that are only accessible in later versions on payment of a fee for a licence key. The unlocked version is known as QuickTime Pro. Other applications have access to the full QuickTime feature set whether or not a Pro licence has been purchased.</p>\n<p>QuickTime was released on 2 December 1991, although it was first demonstrated publicly at a World Wide Developers' Conference in May 1991. There an astonished audience saw QuickTime's lead developer use QuickTime to play Apple's famous 1984 TV commercial 'Blade Runner' (used at the release of the first Macintosh) on a Macintosh, at the time, an astounding technological breakthrough. At first, the screen size and number of frames per second of a movie played with QuickTime was extremely limited, but this was progressively improved over a number of years until QuickTime was able to sustain playing video full screen at 25 frames per second, that is, at a size and rate comparable with that of analogue video tape.</p>\n<p>A person from Melbourne who tested QuickTime in 1991 prior to its release described it as 'an astounding technological breakthrough'. Additionally it was well in advance of Microsoft's competing technology, Video for Windows, which did not appear until November 1992. He was working for an advertising agency at the time. He became excited about QuickTime's animation and sound capabilities, its ability to compress video files, and its use of a virtual reality panoramic photo format. The video editing software of the time required the total resources of a dedicated computer and thus was not transportable. Additionally it was very expensive; only large institutions could afford such software. QuickTime was cheap and stored on a single CD. He was thus able to use QuickTime at home and share in the raising of a family. He says that it still took many years before video was able to become full screen and 25 frames per second.</p>\n<p>In launching a video production business in 1992, the donor purchased a QuickTime Developers Kit as well as the following items:</p>\n<ul>\n<li>Quadra 900 with 2 monitors, and CD ROM reader with SCSI cable \n</li><li>Videospigot for converting analog video into digital \n</li><li>Adobe Premiere 1 for video editing</li></ul>\n<p>The Compact Disks were read by an Apple CD Reader attached to the donor's Quadra 900 by a SCSI cable. Apple was one of the first companies to release a CD Reader, which it did in 1991. This facilitated the delivery of larger sized files of the new multi-megabyte applications including the QuickTime files on these CDs.</p>\n<p>&nbsp;</p>",
  "contentSummary": null,
  "types": [
    "Historical Narrative"
  ],
  "authors": [
    {
      "firstName": "Noel",
      "lastName": "Jackling",
      "fullName": "Mr Noel S. Jackling",
      "biography": "Volunteer with the Apple Company Collection at Museums Victoria.",
      "profileImage": null
    },
    {
      "firstName": "Stephen",
      "lastName": "Withers",
      "fullName": "Mr Stephen Withers",
      "biography": null,
      "profileImage": null
    }
  ],
  "contributors": [],
  "media": [
    {
      "type": "image",
      "alternativeText": null,
      "large": {
        "width": 2694,
        "height": 2048,
        "uri": "https://collections.museumsvictoria.com.au/content/media/21/237771-large.jpg",
        "size": 611226
      },
      "medium": {
        "width": 1500,
        "height": 1140,
        "uri": "https://collections.museumsvictoria.com.au/content/media/21/237771-medium.jpg",
        "size": 151347
      },
      "small": {
        "width": 658,
        "height": 500,
        "uri": "https://collections.museumsvictoria.com.au/content/media/21/237771-small.jpg",
        "size": 40856
      },
      "thumbnail": {
        "width": 250,
        "height": 250,
        "uri": "https://collections.museumsvictoria.com.au/content/media/21/237771-thumbnail.jpg",
        "size": 11243
      },
      "id": "media/237771",
      "dateModified": "2016-11-10T03:36:00Z",
      "caption": "Apple Macintosh Software -  QuickTime Developers Kit",
      "creators": [],
      "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": "2009",
  "parentArticleId": null,
  "childArticleIds": [],
  "relatedArticleIds": [],
  "relatedItemIds": [
    "items/1241375",
    "items/1231822"
  ],
  "relatedSpecimenIds": [],
  "id": "articles/2780"
}

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": "2016-06-01T00:10:00Z",
    "displayTitle": "Apple Model - Northwood, Greensborough, 1875",
    "category": "History & Technology",
    "discipline": "Technology",
    "type": "Object",
    "registrationNumber": "ST 13547",
    "collectionNames": [
      "Whatmough Collection",
      "Wax Fruit Collection"
    ],
    "collectingAreas": [
      "Sustainable Futures"
    ],
    "classifications": [
      "Economic botany",
      "Wax models",
      "Fruits"
    ],
    "objectName": "Apple Model - Northwood, Greensborough, 1875",
    "objectSummary": "This wax model is based on a specimen grown and presented to the museum by Robert Whatmough, Greensborough, 1875. The model was made in the museum by Thomas McMillan in 1875. \n\nThis variety is not in Ikin's Listing of Fruits, 1974 edition.",
    "physicalDescription": null,
    "inscription": null,
    "associations": [
      {
        "type": "Modelmaker",
        "name": "Mr Thomas McMillan - Industrial & Technological Museum",
        "date": "1875",
        "comments": null,
        "streetAddress": null,
        "locality": null,
        "region": null,
        "state": null,
        "country": "Australia"
      },
      {
        "type": "Grower of Item Modelled",
        "name": "Mr Robert Whatmough",
        "date": "1875",
        "comments": null,
        "streetAddress": null,
        "locality": null,
        "region": null,
        "state": null,
        "country": "Australia"
      }
    ],
    "keywords": [
      "Apples",
      "Wax Fruit Models",
      "Horticulture",
      "Museum History"
    ],
    "significance": null,
    "modelScale": null,
    "shape": null,
    "dimensions": [
      {
        "configuration": "Overall Dimensions",
        "dimensions": null,
        "comments": null
      }
    ],
    "references": null,
    "bibliographies": [],
    "modelNames": [],
    "brands": [],
    "relatedItemIds": [],
    "relatedSpecimenIds": [],
    "relatedArticleIds": [
      "articles/1633",
      "articles/1631",
      "articles/1528",
      "articles/1522",
      "articles/1187"
    ],
    "relatedSpeciesIds": [],
    "media": [
      {
        "type": "image",
        "alternativeText": "Green and brown wax model of an apple.",
        "large": {
          "width": 3000,
          "height": 2000,
          "uri": "https://collections.museumsvictoria.com.au/content/media/5/336905-large.jpg",
          "size": 324049
        },
        "medium": {
          "width": 1500,
          "height": 1000,
          "uri": "https://collections.museumsvictoria.com.au/content/media/5/336905-medium.jpg",
          "size": 53670
        },
        "small": {
          "width": 750,
          "height": 500,
          "uri": "https://collections.museumsvictoria.com.au/content/media/5/336905-small.jpg",
          "size": 17361
        },
        "thumbnail": {
          "width": 250,
          "height": 250,
          "uri": "https://collections.museumsvictoria.com.au/content/media/5/336905-thumbnail.jpg",
          "size": 4283
        },
        "id": "media/336905",
        "dateModified": "2016-11-10T04:01:00Z",
        "caption": "Apple Model - Northwood, Victoria, 1875",
        "creators": [],
        "sources": [],
        "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"
        }
      },
      {
        "type": "image",
        "alternativeText": null,
        "large": {
          "width": 728,
          "height": 552,
          "uri": "https://collections.museumsvictoria.com.au/content/media/4/30004-large.jpg",
          "size": 27376
        },
        "medium": {
          "width": 728,
          "height": 552,
          "uri": "https://collections.museumsvictoria.com.au/content/media/4/30004-medium.jpg",
          "size": 22628
        },
        "small": {
          "width": 659,
          "height": 500,
          "uri": "https://collections.museumsvictoria.com.au/content/media/4/30004-small.jpg",
          "size": 28971
        },
        "thumbnail": {
          "width": 250,
          "height": 250,
          "uri": "https://collections.museumsvictoria.com.au/content/media/4/30004-thumbnail.jpg",
          "size": 6249
        },
        "id": "media/30004",
        "dateModified": "2016-11-10T03:37:00Z",
        "caption": "Apple Model, Northwood",
        "creators": [],
        "sources": [],
        "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"
        }
      },
      {
        "type": "image",
        "alternativeText": "Wax model of a green apple. One side damaged to reveal white wax.",
        "large": {
          "width": 3000,
          "height": 2000,
          "uri": "https://collections.museumsvictoria.com.au/content/media/6/336906-large.jpg",
          "size": 314990
        },
        "medium": {
          "width": 1500,
          "height": 1000,
          "uri": "https://collections.museumsvictoria.com.au/content/media/6/336906-medium.jpg",
          "size": 44663
        },
        "small": {
          "width": 750,
          "height": 500,
          "uri": "https://collections.museumsvictoria.com.au/content/media/6/336906-small.jpg",
          "size": 14912
        },
        "thumbnail": {
          "width": 250,
          "height": 250,
          "uri": "https://collections.museumsvictoria.com.au/content/media/6/336906-thumbnail.jpg",
          "size": 3891
        },
        "id": "media/336906",
        "dateModified": "2016-11-10T03:37:00Z",
        "caption": "Apple Model - Northwood, Victoria, 1875",
        "creators": [],
        "sources": [],
        "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": "Donation for Modelling from Mr Robert Whatmough, 1875",
    "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": null,
    "numismaticsSeries": null,
    "numismaticsMaterial": null,
    "numismaticsAxis": null,
    "numismaticsEdgeDescription": null,
    "numismaticsObverseDescription": null,
    "numismaticsReverseDescription": null,
    "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,
    "firstPeoplesLocalities": [],
    "firstPeoplesCulturalGroups": [],
    "firstPeoplesMedium": null,
    "firstPeoplesDescription": null,
    "firstPeoplesLocalName": null,
    "firstPeoplesPhotographer": null,
    "firstPeoplesAuthor": null,
    "firstPeoplesIllustrator": null,
    "firstPeoplesMaker": null,
    "firstPeoplesDate": null,
    "firstPeoplesCollector": null,
    "firstPeoplesDateCollected": null,
    "firstPeoplesIndividualsIdentified": null,
    "firstPeoplesTitle": null,
    "firstPeoplesSheets": null,
    "firstPeoplesPages": null,
    "firstPeoplesLetterTo": null,
    "firstPeoplesLetterFrom": 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/391920"
  }
]

GET

/api/items/{id}


Description

Returns a single item by Id.

Example URL /api/items/391920

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": "2016-06-01T00:10:00Z",
  "displayTitle": "Apple Model - Northwood, Greensborough, 1875",
  "category": "History & Technology",
  "discipline": "Technology",
  "type": "Object",
  "registrationNumber": "ST 13547",
  "collectionNames": [
    "Whatmough Collection",
    "Wax Fruit Collection"
  ],
  "collectingAreas": [
    "Sustainable Futures"
  ],
  "classifications": [
    "Economic botany",
    "Wax models",
    "Fruits"
  ],
  "objectName": "Apple Model - Northwood, Greensborough, 1875",
  "objectSummary": "This wax model is based on a specimen grown and presented to the museum by Robert Whatmough, Greensborough, 1875. The model was made in the museum by Thomas McMillan in 1875. \n\nThis variety is not in Ikin's Listing of Fruits, 1974 edition.",
  "physicalDescription": null,
  "inscription": null,
  "associations": [
    {
      "type": "Modelmaker",
      "name": "Mr Thomas McMillan - Industrial & Technological Museum",
      "date": "1875",
      "comments": null,
      "streetAddress": null,
      "locality": null,
      "region": null,
      "state": null,
      "country": "Australia"
    },
    {
      "type": "Grower of Item Modelled",
      "name": "Mr Robert Whatmough",
      "date": "1875",
      "comments": null,
      "streetAddress": null,
      "locality": null,
      "region": null,
      "state": null,
      "country": "Australia"
    }
  ],
  "keywords": [
    "Apples",
    "Wax Fruit Models",
    "Horticulture",
    "Museum History"
  ],
  "significance": null,
  "modelScale": null,
  "shape": null,
  "dimensions": [
    {
      "configuration": "Overall Dimensions",
      "dimensions": null,
      "comments": null
    }
  ],
  "references": null,
  "bibliographies": [],
  "modelNames": [],
  "brands": [],
  "relatedItemIds": [],
  "relatedSpecimenIds": [],
  "relatedArticleIds": [
    "articles/1633",
    "articles/1631",
    "articles/1528",
    "articles/1522",
    "articles/1187"
  ],
  "relatedSpeciesIds": [],
  "media": [
    {
      "type": "image",
      "alternativeText": "Green and brown wax model of an apple.",
      "large": {
        "width": 3000,
        "height": 2000,
        "uri": "https://collections.museumsvictoria.com.au/content/media/5/336905-large.jpg",
        "size": 324049
      },
      "medium": {
        "width": 1500,
        "height": 1000,
        "uri": "https://collections.museumsvictoria.com.au/content/media/5/336905-medium.jpg",
        "size": 53670
      },
      "small": {
        "width": 750,
        "height": 500,
        "uri": "https://collections.museumsvictoria.com.au/content/media/5/336905-small.jpg",
        "size": 17361
      },
      "thumbnail": {
        "width": 250,
        "height": 250,
        "uri": "https://collections.museumsvictoria.com.au/content/media/5/336905-thumbnail.jpg",
        "size": 4283
      },
      "id": "media/336905",
      "dateModified": "2016-11-10T04:01:00Z",
      "caption": "Apple Model - Northwood, Victoria, 1875",
      "creators": [],
      "sources": [],
      "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"
      }
    },
    {
      "type": "image",
      "alternativeText": null,
      "large": {
        "width": 728,
        "height": 552,
        "uri": "https://collections.museumsvictoria.com.au/content/media/4/30004-large.jpg",
        "size": 27376
      },
      "medium": {
        "width": 728,
        "height": 552,
        "uri": "https://collections.museumsvictoria.com.au/content/media/4/30004-medium.jpg",
        "size": 22628
      },
      "small": {
        "width": 659,
        "height": 500,
        "uri": "https://collections.museumsvictoria.com.au/content/media/4/30004-small.jpg",
        "size": 28971
      },
      "thumbnail": {
        "width": 250,
        "height": 250,
        "uri": "https://collections.museumsvictoria.com.au/content/media/4/30004-thumbnail.jpg",
        "size": 6249
      },
      "id": "media/30004",
      "dateModified": "2016-11-10T03:37:00Z",
      "caption": "Apple Model, Northwood",
      "creators": [],
      "sources": [],
      "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"
      }
    },
    {
      "type": "image",
      "alternativeText": "Wax model of a green apple. One side damaged to reveal white wax.",
      "large": {
        "width": 3000,
        "height": 2000,
        "uri": "https://collections.museumsvictoria.com.au/content/media/6/336906-large.jpg",
        "size": 314990
      },
      "medium": {
        "width": 1500,
        "height": 1000,
        "uri": "https://collections.museumsvictoria.com.au/content/media/6/336906-medium.jpg",
        "size": 44663
      },
      "small": {
        "width": 750,
        "height": 500,
        "uri": "https://collections.museumsvictoria.com.au/content/media/6/336906-small.jpg",
        "size": 14912
      },
      "thumbnail": {
        "width": 250,
        "height": 250,
        "uri": "https://collections.museumsvictoria.com.au/content/media/6/336906-thumbnail.jpg",
        "size": 3891
      },
      "id": "media/336906",
      "dateModified": "2016-11-10T03:37:00Z",
      "caption": "Apple Model - Northwood, Victoria, 1875",
      "creators": [],
      "sources": [],
      "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": "Donation for Modelling from Mr Robert Whatmough, 1875",
  "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": null,
  "numismaticsSeries": null,
  "numismaticsMaterial": null,
  "numismaticsAxis": null,
  "numismaticsEdgeDescription": null,
  "numismaticsObverseDescription": null,
  "numismaticsReverseDescription": null,
  "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,
  "firstPeoplesLocalities": [],
  "firstPeoplesCulturalGroups": [],
  "firstPeoplesMedium": null,
  "firstPeoplesDescription": null,
  "firstPeoplesLocalName": null,
  "firstPeoplesPhotographer": null,
  "firstPeoplesAuthor": null,
  "firstPeoplesIllustrator": null,
  "firstPeoplesMaker": null,
  "firstPeoplesDate": null,
  "firstPeoplesCollector": null,
  "firstPeoplesDateCollected": null,
  "firstPeoplesIndividualsIdentified": null,
  "firstPeoplesTitle": null,
  "firstPeoplesSheets": null,
  "firstPeoplesPages": null,
  "firstPeoplesLetterTo": null,
  "firstPeoplesLetterFrom": 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/391920"
}

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": "2017-02-06T08:28:00Z",
    "displayTitle": "<em>Allocharopa tarravillensis</em> (Gabriel, 1930), pinwheel snail",
    "animalType": "Slugs & snails",
    "animalSubType": "Snails",
    "colours": [
      "light brown"
    ],
    "maximumSize": "3 mm",
    "habitats": [
      "Wet schlerophyll forest"
    ],
    "whereToLook": [
      "Terrestrial"
    ],
    "whenActive": [],
    "nationalParks": null,
    "diet": "Herbivore",
    "dietCategories": [
      "Plant matter"
    ],
    "fastFact": null,
    "habitat": "In litter and under decaying logs in damp situations.",
    "distribution": "Eastern Victoria, South Gippsland area.",
    "biology": "This species is thought to feed on decaying vegetable matter, fungi and biofilm on hard surfaces.",
    "generalDescription": "Shell small, 2-3 mm of four to five whorls (turns) with flat spire, rounded final whorl and obvious ribs radiating out from axis. The space within the middle of the whorls of the shell (the umbilicus) is medium sized. The shell opening (aperture) is a rounded crescent shape. Shell brown with body darker brown, appearing very narrow in comparison with shell.",
    "briefId": "A tiny narrow-bodied snail with a light brown flattened shell with radiating ribs.",
    "hazards": null,
    "endemicity": "Native to Australia",
    "commercial": null,
    "conservationStatuses": [
      "CITES: Not listed",
      "DSE Advisory List: Not listed",
      "EPBC Act 1999: Not listed",
      "IUCN Red List: Near Threatened"
    ],
    "web": null,
    "plants": [],
    "flightStart": null,
    "flightEnd": null,
    "depths": [],
    "waterColumnLocations": [],
    "relatedItemIds": [],
    "relatedSpecimenIds": [],
    "relatedArticleIds": [
      "articles/14374"
    ],
    "relatedSpeciesIds": [],
    "authors": [
      {
        "firstName": "Chris",
        "lastName": "Rowley",
        "fullName": "Chris Rowley",
        "biography": "Collection Manager of Marine Invertebrates at Museums Victoria.",
        "profileImage": {
          "type": "image",
          "alternativeText": "Chris Rowley in wet collection store.",
          "large": {
            "width": 500,
            "height": 500,
            "uri": "https://collections.museumsvictoria.com.au/content/media/12/824512-large.jpg",
            "size": 92145
          },
          "medium": {
            "width": 500,
            "height": 500,
            "uri": "https://collections.museumsvictoria.com.au/content/media/12/824512-medium.jpg",
            "size": 64816
          },
          "small": {
            "width": 500,
            "height": 500,
            "uri": "https://collections.museumsvictoria.com.au/content/media/12/824512-small.jpg",
            "size": 64816
          },
          "thumbnail": {
            "width": 250,
            "height": 250,
            "uri": "https://collections.museumsvictoria.com.au/content/media/12/824512-thumbnail.jpg",
            "size": 18421
          },
          "id": "media/824512",
          "dateModified": "2016-11-10T04:39:00Z",
          "caption": "Chris Rowley, Collection Manager of Invertebrates.",
          "creators": [
            "Unknown photographer"
          ],
          "sources": [
            "Museums Victoria"
          ],
          "credit": null,
          "rightsStatement": "Copyright Museums Victoria / All Rights Reserved",
          "licence": {
            "name": "All Rights Reserved",
            "shortName": "All Rights Reserved",
            "uri": ""
          }
        }
      }
    ],
    "yearWritten": "2016",
    "media": [
      {
        "type": "image",
        "alternativeText": "Small brown snail on brown leaf.",
        "large": {
          "width": 3000,
          "height": 2000,
          "uri": "https://collections.museumsvictoria.com.au/content/media/14/873214-large.jpg",
          "size": 379629
        },
        "medium": {
          "width": 1500,
          "height": 1000,
          "uri": "https://collections.museumsvictoria.com.au/content/media/14/873214-medium.jpg",
          "size": 88307
        },
        "small": {
          "width": 750,
          "height": 500,
          "uri": "https://collections.museumsvictoria.com.au/content/media/14/873214-small.jpg",
          "size": 32491
        },
        "thumbnail": {
          "width": 250,
          "height": 250,
          "uri": "https://collections.museumsvictoria.com.au/content/media/14/873214-thumbnail.jpg",
          "size": 6586
        },
        "id": "media/873214",
        "dateModified": "2016-11-10T04:13:00Z",
        "caption": "Pinwheel Snail, <em>Allocharopa tarravillensis</em>. Lakes Entrance, Gippsland, Victoria.",
        "creators": [
          "Photographer: Adnan Moussalli"
        ],
        "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"
        }
      },
      {
        "type": "image",
        "alternativeText": "Small brown snail on brown leaf.",
        "large": {
          "width": 3000,
          "height": 2000,
          "uri": "https://collections.museumsvictoria.com.au/content/media/13/873213-large.jpg",
          "size": 483478
        },
        "medium": {
          "width": 1500,
          "height": 1000,
          "uri": "https://collections.museumsvictoria.com.au/content/media/13/873213-medium.jpg",
          "size": 116873
        },
        "small": {
          "width": 750,
          "height": 500,
          "uri": "https://collections.museumsvictoria.com.au/content/media/13/873213-small.jpg",
          "size": 41930
        },
        "thumbnail": {
          "width": 250,
          "height": 250,
          "uri": "https://collections.museumsvictoria.com.au/content/media/13/873213-thumbnail.jpg",
          "size": 7889
        },
        "id": "media/873213",
        "dateModified": "2016-11-10T04:13:00Z",
        "caption": "Pinwheel Snail, <em>Allocharopa tarravillensis</em>. Lakes Entrance, Gippsland, Victoria.",
        "creators": [
          "Photographer: Adnan Moussalli"
        ],
        "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"
        }
      },
      {
        "type": "uri",
        "uri": "https://museumsvictoria.com.au/apps/field-guide-app-to-victorian-fauna/",
        "id": "media/900123",
        "dateModified": "2022-12-02T01:07:00Z",
        "caption": "Get the free MV Field Guide to Victorian Fauna app for Apple and Android devices",
        "creators": [],
        "sources": [],
        "credit": null,
        "rightsStatement": null,
        "licence": {
          "name": "All Rights Reserved",
          "shortName": "All Rights Reserved",
          "uri": ""
        }
      }
    ],
    "taxonomy": {
      "kingdom": "Animalia",
      "phylum": "Mollusca",
      "subphylum": null,
      "superclass": null,
      "class": "Gastropoda",
      "subclass": "Heterobranchia",
      "superorder": "Eupulmonata",
      "order": "Stylommatophora",
      "suborder": "Helicina",
      "infraorder": null,
      "superfamily": "Punctoidea",
      "family": "Charopidae",
      "subfamily": null,
      "genus": "Allocharopa",
      "subgenus": null,
      "species": "tarravillensis",
      "subspecies": null,
      "author": "(Gabriel, 1930)",
      "code": "ICZN",
      "taxonName": "Allocharopa tarravillensis",
      "commonName": "pinwheel snail",
      "otherCommonNames": [
        "land snail"
      ]
    },
    "id": "species/10538"
  }
]

GET

/api/species/{id}


Description

Returns a single species by Id.

Example URL /api/species/10538

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": "2017-02-06T08:28:00Z",
  "displayTitle": "<em>Allocharopa tarravillensis</em> (Gabriel, 1930), pinwheel snail",
  "animalType": "Slugs & snails",
  "animalSubType": "Snails",
  "colours": [
    "light brown"
  ],
  "maximumSize": "3 mm",
  "habitats": [
    "Wet schlerophyll forest"
  ],
  "whereToLook": [
    "Terrestrial"
  ],
  "whenActive": [],
  "nationalParks": null,
  "diet": "Herbivore",
  "dietCategories": [
    "Plant matter"
  ],
  "fastFact": null,
  "habitat": "In litter and under decaying logs in damp situations.",
  "distribution": "Eastern Victoria, South Gippsland area.",
  "biology": "This species is thought to feed on decaying vegetable matter, fungi and biofilm on hard surfaces.",
  "generalDescription": "Shell small, 2-3 mm of four to five whorls (turns) with flat spire, rounded final whorl and obvious ribs radiating out from axis. The space within the middle of the whorls of the shell (the umbilicus) is medium sized. The shell opening (aperture) is a rounded crescent shape. Shell brown with body darker brown, appearing very narrow in comparison with shell.",
  "briefId": "A tiny narrow-bodied snail with a light brown flattened shell with radiating ribs.",
  "hazards": null,
  "endemicity": "Native to Australia",
  "commercial": null,
  "conservationStatuses": [
    "CITES: Not listed",
    "DSE Advisory List: Not listed",
    "EPBC Act 1999: Not listed",
    "IUCN Red List: Near Threatened"
  ],
  "web": null,
  "plants": [],
  "flightStart": null,
  "flightEnd": null,
  "depths": [],
  "waterColumnLocations": [],
  "relatedItemIds": [],
  "relatedSpecimenIds": [],
  "relatedArticleIds": [
    "articles/14374"
  ],
  "relatedSpeciesIds": [],
  "authors": [
    {
      "firstName": "Chris",
      "lastName": "Rowley",
      "fullName": "Chris Rowley",
      "biography": "Collection Manager of Marine Invertebrates at Museums Victoria.",
      "profileImage": {
        "type": "image",
        "alternativeText": "Chris Rowley in wet collection store.",
        "large": {
          "width": 500,
          "height": 500,
          "uri": "https://collections.museumsvictoria.com.au/content/media/12/824512-large.jpg",
          "size": 92145
        },
        "medium": {
          "width": 500,
          "height": 500,
          "uri": "https://collections.museumsvictoria.com.au/content/media/12/824512-medium.jpg",
          "size": 64816
        },
        "small": {
          "width": 500,
          "height": 500,
          "uri": "https://collections.museumsvictoria.com.au/content/media/12/824512-small.jpg",
          "size": 64816
        },
        "thumbnail": {
          "width": 250,
          "height": 250,
          "uri": "https://collections.museumsvictoria.com.au/content/media/12/824512-thumbnail.jpg",
          "size": 18421
        },
        "id": "media/824512",
        "dateModified": "2016-11-10T04:39:00Z",
        "caption": "Chris Rowley, Collection Manager of Invertebrates.",
        "creators": [
          "Unknown photographer"
        ],
        "sources": [
          "Museums Victoria"
        ],
        "credit": null,
        "rightsStatement": "Copyright Museums Victoria / All Rights Reserved",
        "licence": {
          "name": "All Rights Reserved",
          "shortName": "All Rights Reserved",
          "uri": ""
        }
      }
    }
  ],
  "yearWritten": "2016",
  "media": [
    {
      "type": "image",
      "alternativeText": "Small brown snail on brown leaf.",
      "large": {
        "width": 3000,
        "height": 2000,
        "uri": "https://collections.museumsvictoria.com.au/content/media/14/873214-large.jpg",
        "size": 379629
      },
      "medium": {
        "width": 1500,
        "height": 1000,
        "uri": "https://collections.museumsvictoria.com.au/content/media/14/873214-medium.jpg",
        "size": 88307
      },
      "small": {
        "width": 750,
        "height": 500,
        "uri": "https://collections.museumsvictoria.com.au/content/media/14/873214-small.jpg",
        "size": 32491
      },
      "thumbnail": {
        "width": 250,
        "height": 250,
        "uri": "https://collections.museumsvictoria.com.au/content/media/14/873214-thumbnail.jpg",
        "size": 6586
      },
      "id": "media/873214",
      "dateModified": "2016-11-10T04:13:00Z",
      "caption": "Pinwheel Snail, <em>Allocharopa tarravillensis</em>. Lakes Entrance, Gippsland, Victoria.",
      "creators": [
        "Photographer: Adnan Moussalli"
      ],
      "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"
      }
    },
    {
      "type": "image",
      "alternativeText": "Small brown snail on brown leaf.",
      "large": {
        "width": 3000,
        "height": 2000,
        "uri": "https://collections.museumsvictoria.com.au/content/media/13/873213-large.jpg",
        "size": 483478
      },
      "medium": {
        "width": 1500,
        "height": 1000,
        "uri": "https://collections.museumsvictoria.com.au/content/media/13/873213-medium.jpg",
        "size": 116873
      },
      "small": {
        "width": 750,
        "height": 500,
        "uri": "https://collections.museumsvictoria.com.au/content/media/13/873213-small.jpg",
        "size": 41930
      },
      "thumbnail": {
        "width": 250,
        "height": 250,
        "uri": "https://collections.museumsvictoria.com.au/content/media/13/873213-thumbnail.jpg",
        "size": 7889
      },
      "id": "media/873213",
      "dateModified": "2016-11-10T04:13:00Z",
      "caption": "Pinwheel Snail, <em>Allocharopa tarravillensis</em>. Lakes Entrance, Gippsland, Victoria.",
      "creators": [
        "Photographer: Adnan Moussalli"
      ],
      "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"
      }
    },
    {
      "type": "uri",
      "uri": "https://museumsvictoria.com.au/apps/field-guide-app-to-victorian-fauna/",
      "id": "media/900123",
      "dateModified": "2022-12-02T01:07:00Z",
      "caption": "Get the free MV Field Guide to Victorian Fauna app for Apple and Android devices",
      "creators": [],
      "sources": [],
      "credit": null,
      "rightsStatement": null,
      "licence": {
        "name": "All Rights Reserved",
        "shortName": "All Rights Reserved",
        "uri": ""
      }
    }
  ],
  "taxonomy": {
    "kingdom": "Animalia",
    "phylum": "Mollusca",
    "subphylum": null,
    "superclass": null,
    "class": "Gastropoda",
    "subclass": "Heterobranchia",
    "superorder": "Eupulmonata",
    "order": "Stylommatophora",
    "suborder": "Helicina",
    "infraorder": null,
    "superfamily": "Punctoidea",
    "family": "Charopidae",
    "subfamily": null,
    "genus": "Allocharopa",
    "subgenus": null,
    "species": "tarravillensis",
    "subspecies": null,
    "author": "(Gabriel, 1930)",
    "code": "ICZN",
    "taxonName": "Allocharopa tarravillensis",
    "commonName": "pinwheel snail",
    "otherCommonNames": [
      "land snail"
    ]
  },
  "id": "species/10538"
}

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": "2020-09-30T23:10:00Z",
    "displayTitle": "<em>Ocybadistes</em>",
    "category": "Natural Sciences",
    "scientificGroup": "Invertebrate Zoology",
    "discipline": "Entomology",
    "registrationNumber": "LEP 54215",
    "collectionNames": [
      "D.R. Holmes 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": "Unknown",
    "stageOrAge": "adult",
    "storages": [
      {
        "nature": null,
        "form": "pinned",
        "fixativeTreatment": null,
        "medium": null
      }
    ],
    "typeStatus": null,
    "identifiedBy": null,
    "dateIdentified": null,
    "qualifier": null,
    "qualifierRank": "None",
    "taxonomy": {
      "kingdom": "Animalia",
      "phylum": "Arthropoda",
      "subphylum": "Hexapoda",
      "superclass": null,
      "class": "Insecta",
      "subclass": null,
      "superorder": null,
      "order": "Lepidoptera",
      "suborder": null,
      "infraorder": null,
      "superfamily": null,
      "family": "Hesperiidae",
      "subfamily": null,
      "genus": "Ocybadistes",
      "subgenus": null,
      "species": null,
      "subspecies": null,
      "author": null,
      "code": "ICZN",
      "taxonName": "Ocybadistes",
      "commonName": null,
      "otherCommonNames": []
    },
    "collectionEvent": {
      "expeditionName": null,
      "collectionEventCode": null,
      "samplingMethod": null,
      "dateVisitedFrom": "1985-12-05T00:00:00",
      "dateVisitedTo": "1985-12-05T00:00:00",
      "depthTo": null,
      "depthFrom": null,
      "collectedBy": "Mr David Robert Holmes"
    },
    "collectionSite": {
      "siteCode": null,
      "ocean": null,
      "continent": null,
      "country": "Australia",
      "state": "Victoria",
      "district": null,
      "town": null,
      "nearestNamedPlace": "Dromana",
      "preciseLocation": "Dromana",
      "minimumElevation": null,
      "maximumElevation": null,
      "latitudes": null,
      "longitudes": null,
      "geodeticDatum": "WGS84",
      "siteRadius": null,
      "georeferenceBy": null,
      "georeferenceDate": null,
      "georeferenceProtocol": "compiler",
      "georeferenceSource": null,
      "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/1404348"
  }
]

GET

/api/specimens/{id}


Description

Returns a single specimen by Id.

Example URL /api/specimens/1404348

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": "2020-09-30T23:10:00Z",
  "displayTitle": "<em>Ocybadistes</em>",
  "category": "Natural Sciences",
  "scientificGroup": "Invertebrate Zoology",
  "discipline": "Entomology",
  "registrationNumber": "LEP 54215",
  "collectionNames": [
    "D.R. Holmes 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": "Unknown",
  "stageOrAge": "adult",
  "storages": [
    {
      "nature": null,
      "form": "pinned",
      "fixativeTreatment": null,
      "medium": null
    }
  ],
  "typeStatus": null,
  "identifiedBy": null,
  "dateIdentified": null,
  "qualifier": null,
  "qualifierRank": "None",
  "taxonomy": {
    "kingdom": "Animalia",
    "phylum": "Arthropoda",
    "subphylum": "Hexapoda",
    "superclass": null,
    "class": "Insecta",
    "subclass": null,
    "superorder": null,
    "order": "Lepidoptera",
    "suborder": null,
    "infraorder": null,
    "superfamily": null,
    "family": "Hesperiidae",
    "subfamily": null,
    "genus": "Ocybadistes",
    "subgenus": null,
    "species": null,
    "subspecies": null,
    "author": null,
    "code": "ICZN",
    "taxonName": "Ocybadistes",
    "commonName": null,
    "otherCommonNames": []
  },
  "collectionEvent": {
    "expeditionName": null,
    "collectionEventCode": null,
    "samplingMethod": null,
    "dateVisitedFrom": "1985-12-05T00:00:00",
    "dateVisitedTo": "1985-12-05T00:00:00",
    "depthTo": null,
    "depthFrom": null,
    "collectedBy": "Mr David Robert Holmes"
  },
  "collectionSite": {
    "siteCode": null,
    "ocean": null,
    "continent": null,
    "country": "Australia",
    "state": "Victoria",
    "district": null,
    "town": null,
    "nearestNamedPlace": "Dromana",
    "preciseLocation": "Dromana",
    "minimumElevation": null,
    "maximumElevation": null,
    "latitudes": null,
    "longitudes": null,
    "geodeticDatum": "WGS84",
    "siteRadius": null,
    "georeferenceBy": null,
    "georeferenceDate": null,
    "georeferenceProtocol": "compiler",
    "georeferenceSource": null,
    "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/1404348"
}