Locations API Documentation - Version 1

Methods - health

[OPTIONS]/health

Returns a 200 OK status if the API is currently available. It is suitable to use this method for up-time monitoring etc.

Note: This does not indicate the reliability or performance of the API, it is simply a binary value as to it’s (current) availability.

Note: See the associated GET method if you require a more detailed response (i.e. a payload).

Parameters

None.

Options

None.

Example request

URL: https://api.bas.ac.uk/locations/v1/health

Note: Interactive examples for this method may be covered in the examples document.

Headers
Key Value
Content-Type application/json
Accept application/json
Body (Raw)

N/A

Example response (200 OK)
Headers
Key Value
Content-Type application/json
Body (JSON)

N/A

[GET]/health

Returns a 200 OK status if the API is currently available. It is suitable to use this method for up-time monitoring etc.

Note: This does not indicate the reliability or performance of the API, only it’s (current) availability.

Parameters

None.

Options

None.

Example request

URL: https://api.bas.ac.uk/locations/v1/health

Note: Interactive examples for this method may be covered in the examples document.

Headers
Key Value
Content-Type application/json
Accept application/json
Body (Raw)

N/A

Example response (200 OK)
Headers
Key Value
Content-Type application/json
Body (JSON)
{
    "status": "UP"
}

This information may be out of date whilst this website is being redeveloped. Until then, if you have any problems using an API documented here, please contact the relevant project maintainer.