Skip to content

Technical Overview & API Documentation

Web browser requirements

The mapping and visualisation components of the database require a modern web browser - if you encounter problems with these areas, you should check that you are using an up-to-date web browser.


Design & development

Data is stored in a relational (MySQL) database. The web application was built using the Laravel PHP Framework.

Data visualisation on the site is implemented using Leaflet, HighCharts, and D3.


Open Data & Data Access

Data from the database can be accessed in 3 ways, each subject to the license above:

  1. Via the web front-end, accessible using the menu above;
  2. By downloading a .csv file containing some or all of the data. This option is presented at the top of the catalogue page where you can filter and refine the data you would like to download;
  3. By accessing the data via a JSON API (Application Programming Interface). Documentation on accessing data using this method is provided below.

Developer API Access

If you plan to access data in this way, please contact mark.stansbury@nuigalway.ie. Depending on usage, this API may require authentication in the future, or be subject to changes to endpoints or data formats.


Endpoints

The API uses a RESTful approach, with all endpoints supporting GET requests only. All data is returned in JSON format.

The current version of the API is v1.

The Base URL for the API is: http://elmss.nuigalway.ie/api/v1 - this should precede all endpoints listed below.

[GET] /catalogue

Returns a listing of manuscripts in the catalogue.

[GET] /catalogue/{id}

Returns an object with details for a single manuscript.

Parameter (REQUIRED): {id} - this is a numeric value that identifies the manuscript. A full list of manuscripts can be obtained with a request to /catalogue, described above.

[GET] /corpus

Returns a listing of curated Collections in the catalogue.

[GET] /corpus/{id}

Returns an object with details for a single collection.

Parameter (REQUIRED): {id} - this is a numeric value that identifies the collection. A full list of collections can be obtained with a request to /corpus, described above.

The object returned includes a name and description for the collection, along with a catalogue array of manuscript objects.