Public API

The public API provides access to information about all the items publically available in this catalogue.

The public API for this catalogue is available.

Available API Calls

https://equipment.lboro.ac.uk/api/public/items.json

List all available items.

https://equipment.lboro.ac.uk/api/public/items.json?search=[keywords]

Search the available items for a given query. Use the querystring parameter to define the terms to search for.

https://equipment.lboro.ac.uk/api/public/items.json?category=[category-id]

Search for items with the given category id. Use the querystring parameter to define the category to search for.

https://equipment.lboro.ac.uk/api/public/items.json?ou=[ou-id]

Search for items with the given Organisational Unit id. Use the querystring parameter to define the OU to search for.

https://equipment.lboro.ac.uk/api/public/items.json?ou-name=[ou-name]

Search for items with the given Organisational Unit name. Use the querystring parameter to define the OU.

https://equipment.lboro.ac.uk/api/public/items.json?tag=[tag-name]

Search for items with the given tag. Use the querystring parameter to define the tag to search for.

https://equipment.lboro.ac.uk/api/public/item/[id-number]

Show an individual item. Use the item ID number path parameter to define which item to return.

https://equipment.lboro.ac.uk/api/public/categories.json

List all available categories.

Available Formats

To switch output formats, add the appropriate file extension to the url:

e.g.   https://equipment.lboro.ac.uk/api/public/items/index.csv
or     https://equipment.lboro.ac.uk/api/public/items/index.json

The following output formats are supported for the given file exensions:

File Extension	Mime Type	Description
.csv	text/csv	CSV output.
.html	text/html	Human readable, basic HTML output. You can use this view for testing the API calls in a browser.
.json	application/json	JSON format. This is the default output format.
.rdf	application/rdf+xml	RDF output.
.xml	application/xml	XML output.