Introduction

The RRN API exposes the data contained within the RRN in a structured way for use by developers. Please feel free to email technical@rrncommunity.org if you have any feedback about the API. We'd love to know how you're using the RRN API, send us an email and let us know!

Search API

A page of items can be retrieved in an XML or JSON representation by appending .xml or .json to the end of the path.

http://www.rrncommunity.org/items.xml or http://www.rrncommunity.org/items.json

Any search that can be done using the faceted search tools can also be represented as XML (or JSON) using the same approach.

http://www.rrncommunity.org/items.xml?filters=type mask, culture Haida

NOTE: Route-globbed search urls are no longer supported. Please update your links accordingly.

/items/type-mask/culture-Haida becomes /items?filters=type mask, culture Haida

Options

page
The page of results that is returned. The default is 1. http://www.rrncommunity.org/items.json?page=2
per_page
The number of results that are returned. The maximum is 100 and the default is 10. http://www.rrncommunity.org/items.json?per_page=25

Item Record API

XML and JSON representations of a single item can be returned in a similar manner.

http://www.rrncommunity.org/items/1.xml or http://www.rrncommunity.org/items/1.json

Autocompletion API

Returns a JSON array of autocompleted search queries. The API will try to autocomplete the last tag provided. Results are returned sorted by number of results.

http://www.rrncommunity.org/filters/autocomplete_tags.json?filters=m

The results can be limited to a single facet by adding that facet param to the query.

http://www.rrncommunity.org/filters/autocomplete_tags.json?filters=type m

Results are also limited based on the complete search clauses in the query string.

http://www.rrncommunity.org/filters/autocomplete_tags.json?filters=culture Haida, type m

Result Format

type
The facet of the autocompleted tag (e.g. type, made of, held at).
name
The text that should be displayed to the user.
value
The search query that should be executed if the user selects this result.
count
The number of search results that will be returned by this search query.
prefix
Any complete boolean clauses in the autocompleted facet (e.g. the prefix for "made of wood and m" would be "wood and ").

Tag Cloud API

Returns a JSON array of tags for a particular facet. Results are returned in alphabetical order.

http://www.rrncommunity.org/filters.json?filter_type=item_types

The tags can be limited by providing a search query.

http://www.rrncommunity.org/filters.json?filter_type=materials&filters=type mask

Options

filter_type
The facet to return tags for. The filter_type for a particular facet can be found by inspecting the data-filter-type HTML attribute of that tag cloud on the RRN.

Result Format

name
The text that should be displayed to the user.
count
The number of search results that will be returned by this search query.

Links and Logos

You may use these images if you would like to link back to the RRN.

Our collections on the rrn Research our collections See this item on the rrn See this object on the rrn

Rrn logo 150x150 Rrn logo 100x100

Application Gallery

The following is a list of projects which make use of the RRN's API. Please email us at feedback@rrncommunity.org if you would like to add your site to the list.

Inuvialuit Pitqusiit Inuuniarutait: Inuvialuit Living History

This project is focused on a little-known collection of objects housed at the Smithsonian Institution in Washington, DC. Called the MacFarlane Collection after the Hudson’s Bay trader who assembled the objects, the collection includes nearly 5000 natural history specimens, such as birds’ eggs and animal skeletons, and an additional 300 cultural objects collected from Anderson River Inuvialuit in the 1860s.

View this Site