themes/getitems

Retrieve all items associated with a certain theme. Results will be paged and sorted by relevance.

Parameters

Parameter Type Default Restrictions Description
id (required) integer Unique identifier indicating which theme to retrieve.
detail (optional) integer 1 min>=1, max<=3 Determines what level of detail the returned items will contain. 1 being the briefest through to 3, the most verbose.
start (optional) integer 1 min>=1, max={totalItems} Indicates at what item number to start paging at. If the value does not lie at the beginning of a page it will be rounded down to the nearest page.
size (optional) integer 1 min>=1, max=500 Specifies the amount of items to return per page.

Example

For example this will retrieve all items associated with a theme that has an id of 2112.

http://museumvictoria.com.au/collections/api/v1/themes/getitems?id=2112

The response will look something like this:

<items>
  <pagedItems>
    <item>
      <idgt;58027</id>
      <name>Token - 1 Penny, James Wallace, Grocer, Wellington, New Zealand, 1859</name>
      <registrationNumber>NU 11599</registrationNumber>
      <url>...</url>
      <type>Numismatics</type>
      <summary>Copper One Penny Token, minted by W.J. Taylor, London. Issued by ...</summary>
      <description>A round copper token (29 mm diameter). The piece features the ...</description>
      <image>
        <description>A round copper token (29 mm diameter). The piece features ...</description>
        <id>79000</id>
        <title>James Wallace Token Penny</title>
      </image>
    </item>
    <item>
    ...
  </pagedItems>
  <size>10</size>
  <start>1</start>
  <totalItems>7</totalItems>
</items>

Errors

Code Message
1 Maintenance - Site is down for maintenance and will be back shortly.
2 ResourceNotFound - Theme could not be found.
400 InvalidParameter - Request is either missing a required parameter or parameter is of an invalid type.
Yes No