API Protocol

The web service will implement a RESTful JSON standard, using the appropriate HTTP method

to a route of the form /<version>/<request_path>


The webservice will require an APIkey that will be a SHA-256 base64 encoded hash. This API

key is to be sent in the header of each request using header name “Authorization” value

formatted as <type><key> 

Request Format

All request data (POST data) will be JSON

Error Handling

HTTP Status codes should be used to indicate the outcome of an API call.

Additionally, theAPI should return an error payload for an API call, especially for POST and

PUT calls. This will allow for better feedback to front end users and allow developers to

differentiate between technical connection issues and missing data on the request.The API

client should validate data before making a web service call to minimise these cases.