Search the collections
Api Documentation
Api Methods
Items
Themes
Tags
Locations
tags/getitems
Retrieve all items that have been tagged by a certain tag. Results will be paged.
Parameters
| Parameter | Type | Default | Restrictions | Description |
|---|---|---|---|---|
name (required) |
string | The name of the tag that is to be retrieved. | ||
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 tagged by the tag named tractor.
http://museumvictoria.com.au/collections/api/v1/tags/getitems?name=tractors
The response will look something like this:
<items>
<pagedItems>
<item>
<id>392015</id>
<name>Tractor - Williames Wildcat, 1973</name>
<registrationNumber>ST 030387</registrationNumber>
<url>...</url>
<type>Object</type>
<summary>Geoffrey A. Williames developed a new concept for a safer ...</summary>
<image>
<description>WILLIAMES 'WILDCAT' TRACTOR WITH 14 KW SACHS- ...</description>
<id>37677</id>
<title>Tractor - Williames Wildcat, 1973</title>
</image>
</item>
...
</pagedItems>
<size>10</size>
<start>1</start>
<totalItems>1431</totalItems>
</items>
Errors
| Code | Message |
|---|---|
| 1 | Maintenance - Site is down for maintenance and will be back shortly. |
| 2 | ResourceNotFound - Tag could not be found. |
| 400 | InvalidParameter - Request is either missing a required parameter or parameter is of an invalid type. |
