Skip to main content
GET
Get a person's exposure limit

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

org_id
string<uuid>
required

The unique identifier for the organisation.

user_id
string<uuid>
required

The unique identifier for the user.

Query Parameters

exposure_type
enum<string>
required

The exposure type to resolve the limit for. The type of exposure a limit applies to. havs (hand-arm vibration, in points) is the only type.

Available options:
havs
Example:

"havs"

at
string<date-time>

The instant to resolve the limit at. Defaults to now. It resolves on its Europe/London calendar date.

Response

Get an effective exposure limit.

JSON API response object

data
object
required

A person's effective amber and red values for one exposure type on a date, computed when asked for: the lowest of the HSE values, the organisation's thresholds in force and every health plan in force for them. It names the layer that set red, and never carries a health plan or note.

jsonapi
object
required