Skip to main content

Tabula API documentation

The Tabula API utilises REST, using predictable resource-oriented URLs and using HTTP response codes to indicate API errors. The API uses built-in HTTP features like HTTP authentication and verbs, which can be understood by off-the-shelf clients and libraries. JSON will be returned in all responses from the API, including errors.

Authentication

All Tabula resources are protected by Web sign-on. This means that any script will need to pass an ITS user code and password to Tabula. You must ensure that if your scripts store passwords anywhere, they do so in a way which is secure. Failure to do so may result in your access to IT facilities being revoked. API requests should be made using an External User account that is setup specifically for API access, contact the ITS web team at webteam at warwick dot ac dot uk if you need help setting one up.

More information and examples

Resource Management

It's quite possible to make a client for the Tabula APIs which will overload the server, either by accident or design. We monitor the server load more or less continuously, and will block IP addresses from clients which are causing problems on a 'block-first, ask questions later' basis. If we can't identify you from your IP address, we'll simply block the IP address and wait for you to contact us. You can make it easier for us to find out who you are by including contact info (a name or email address) in your user-agent string.

Errors

Tabula uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing or in the wrong format), and codes in the 5xx range indicate an error with the Tabula server.

More information and examples

Versioning

We aim to never release backwards-incompatible changes to the Tabula API for the version requested. We may introduce more fields in the output in the same version, but will never remove or change the format of existing fields.

Tabula Sandbox

You can use tabula-sandbox.warwick.ac.uk to test Tabula's features and functionality without affecting any real data. If you would like access to Tabula Sandbox, please send an email to tabula at warwick dot ac dot uk.

There are some important differences in this version of Tabula:

  • Features and functionality may be enabled that are not enabled on the live system
  • No staff data exists on the system at all
  • Student data is automatically generated, using fake names
  • No emails will be sent by the system, so feel free to play around without worrying

Please make sure you do not upload any sensitive data to the sandbox, such as anything relating to real students.

Tabula API Methods