People API Documentation - Version 1

Methods - Heartbeat

[OPTIONS:GET]/heartbeat

`[OPTIONS|GET]/heartbeat`

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 health or performance of the API, it is simply a binary value as to it’s (current) availability.

Note: This method SHOULD be accessed using the OPTIONS verb wherever possible. For comparability, the GET verb MAY be used but this is not recommended.

Trait	Enabled
Authenticated	No

Parameters

None.

Options

None.

Example request

URL: https://api.bas.ac.uk/people/v1/heartbeat

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)

        {
    "data": {
        "heartbeat": "badump, badump"
    }
}

      

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.