You can use our metadata to create a new widget, mashup or application. We have an Application Programmer’s Interface (API) that is easy to use and quick to get started with.  Via the API you can submit search queries to return metadata for individual projects, partners or subjects.

The API is based upon OpenSearch, and by default takes a Lucene style query syntax.  The API is available via a rate limiting proxy, API search requests are limited to 900 requests per hour.  The data made available through the API is licenced as Creative Commons Attribution Non-Commercial 2.0 UK and you are asked to provide a credit and link back to Exploring Surrey’s Past website in your application or mashup.   For non-rate limited, or commercial use, of the data please contact Exploring Surrey’s Past for licensing terms.  Our open data feed must not be used for any commercial planning or development use.  You agree to your use of our API being monitored.

Getting Started

Please request an API key from the developers:  Orangeleaf Systems Ltd  info@orangeleaf.com

The search records API call is passed a search query and returns a corresponding result set.

URL Format

http://api.collectionsbase.org.uk/os/?queryType=lucene&[REQUEST PARAMETERS]&fq[]=dcterms.isPartOf:ESP&facet=on&key=123456

you must have: queryType=lucene and fq[]=dcterms.isPartOf:ESP to just search Exploring Surrey’s Past as CollectionsBase holds many data sets from many different projects.

REQUEST PARAMETERS:

you must have q=search term

key=your api key from Orangeleaf Systems

optionally,

startPage=N the offset from which the result list paging should start, default is 1

count=N the number of the results to return in the listing, the default is 15

sort=title – the field upon which results are sorted. If sort isn’t specified the results are sorted by relevance. sort by title is the other option

facet=on – show the default facet lists

facet.mincount=10 – show only facets with at least 10 documents in the index

format=rss – other formats to follow, defaults to RSS

Examples

http://api.collectionsbase.org.uk/os/?queryType=lucene&startPage=1&q=painting&count=15&fq[]=dcterms.isPartOf:ESP&facet=on&format=rss&key=123456

Advanced Query Syntax

q=+term1 +term2   both terms must match in documents

q=+term1 -term2  term1 must be in documents, term2 must not be in documents

q=dc.subject:term1  search only dc.subject index

Indexes

By default, all contents are searched.  You can narrow this to just the following Qualified Dublin Core indices:

  • dc.subject
  • dc.creator
  • dcterms.temporal
  • dcterms.spatial
  • dc.title
  • dc.description
  • dc.source
  • dcterms.format

Additional Query Filters

If you wish to have additional Filter Query parameters, supply them in the standard array syntax.  So, to show only results with a thumbnail image, use fq[]=have_thumbnail:1

Example:

http://api.collectionsbase.org.uk/os/?queryType=lucene&startPage=1&q=painting&count=15&fq[]=dcterms.isPartOf:ESP&facet=on&format=rss&fq[]=have_thumbnail:1&key=123456

fq[]=type:museum filters just for museum records

Above all, have fun :-)

If you have any questions please email the developers at info@orangeleaf.com.

Leave a Comment

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

  • Wilfred Noyce, a member of the successful Everest expedition of 1953, was a schoolmaster at Charterhouse and a...