> ## Documentation Index > Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt > Use this file to discover all available pages before exploring further. # Record a HAVS exposure > Record a completed period of hand-arm vibration exposure against an HSE Table 1 category (`havs-equipment`). The category's recommended initial magnitude is copied onto the record, and points, A(8) and the trigger time are derived from it. A later change to the category does not restate the record. A category whose recommended initial magnitude is zero or less is refused. Its points, A(8) and trigger time would not be meaningful values. The subject defaults to the caller. Recording for someone else needs the `havs-exposures:create-on-behalf` permission, and the record keeps who recorded it. ## OpenAPI ````yaml /api-reference/openapi.yaml post /v3/havs-exposures openapi: 3.1.0 info: contact: email: support@ctrl-hub.com name: Ctrl Hub url: https://www.ctrl-hub.com description: > Ctrl Hub is the all-in-one platform for high-risk industries like utilities, construction, infrastructure, and renewables. We help teams manage everything from risk assessments and HAVS exposure to vehicle and equipment checks, with a guaranteed minimum of 200% ROI. license: name: MIT License url: https://opensource.org/licenses/MIT summary: An API for managing your compliance and risk posture termsOfService: https://www.ctrl-hub.com/terms-conditions title: Ctrl Hub version: 1.0.0 servers: - description: Production url: https://api.ctrl-hub.com - description: Staging url: https://api.ctrl-hub.dev - description: Development url: https://api.ctrl-hub.run security: [] tags: - description: | Actions are follow-ups assigned to users and teams, produced manually or by domain producers such as the data-capture workflow runner. name: Actions - description: | Audit events are the events that are logged by the system. name: Audit Events - description: | View the platform's health and availability. name: Status - description: > User-owned dashboards composed of cards on a fixed-slot bento layout. Cards come from a per-domain registry; the API stores their config as opaque JSON. name: Dashboards - description: > Copies of a mobile device's local database, sent by the operative on request so that people in their organisation can recover work that never reached the server. Kept for 30 days, and visible to people granted `device-backups:view` in the organisation each is filed against. name: Device Backups - description: > A record of documents the platform generated and handed over, retained as evidence of what was issued. `subject_type` says what kind of records an export covers, and it is what decides how the request is authorised: there is no export permission of its own, so if you can see the records you can export them. name: Exports - description: > Scheduled delivery of a saved query's results, as a CSV attachment or a summary email. Every run is retained with the file it sent, so what a recipient received stays retrievable. A report runs as the person who created it, under their own access. name: Reports - description: | Manage appointments for work to be carried out with your customers name: Customer Appointments - description: | Manage interactions you have with your customers name: Customer Interactions - description: | Manage accounts for your customers name: Customer Accounts and Contacts - description: > Competency: the assessments, training items, inductions and registrations an organisation requires, and the specifications that combine them. name: Qualifications - description: | Workflows allow you to automate your processes. name: Workflows - description: | Manage documents name: Documents - description: | Manage documents name: Folders - description: | Manage documents name: Document Reviews - description: | Manage feature configurations for an organisation. name: Feature Configurations - description: | Equipment are the physical assets that an organisation manages. name: Equipment - description: | The central cost register: time-versioned rate codes for material, labour, contractor and miscellaneous spend, used to cost work against the job hierarchy. name: Costs - description: > Locations are places an organisation manages, optionally classified by a location type. name: Locations - description: > Bulk loads of locations from an uploaded CSV. An import matches rows on the organisation's own `reference`, so re-importing a corrected file updates what is already there rather than doubling the population, and the import record is the audit trail for the whole load: the bulk write path deliberately emits no per-row events. name: Location Imports - description: | Manage your forms and their schemas name: Forms, Schemas and Categories - description: | Create and view form submissions name: Submissions - description: | View the roles available in the system. name: IAM Roles - description: > IAM role groups can be assigned to principals to manage authorisation centrally. name: IAM Role Groups - description: | Manage service accounts which can access the API programmatically. name: Service Accounts - description: | Manage bridges between organisations. name: Bridges - description: | Manage settings for an organisation. name: Settings - description: | Manage teams within an organisation. name: Teams - description: | Manage job roles within an organisation. name: Job Roles - description: | Manage users and accounts. name: Users - description: | Invite and manage invitations to organisations. name: Invitations - description: > IAM grants are the asignment of roles or permissions to principals to manage resource access. name: IAM Grants - description: | View the permissions available in the system. name: IAM Permissions - description: | SSO providers are the identity providers for an organisation. name: SSO Providers - description: | Whoami returns information about the currently authenticated principal. name: Whoami - description: | Your personal inbox. A notification is the thing you receive: an envelope that carries what happened to one or more channels. Email is one of those channels, the inbox is another, and this is where the ones delivered to your inbox are listed, read, saved and archived. name: Notifications - description: | Manage your images name: Images - description: > AI agent personas that synthesise data into role-specific intelligent briefings. name: Agents - description: | Briefings generated by AI agents, including reasoning traces. name: Briefings - description: > Organisations are the center point for most resources in the platform. Most other endpoints are subresources of an organisation. name: Organisations - description: | Permits managements, integrated with street manager. name: Permits - description: | Projects manage your work and governance. name: Projects - description: > Import templates allow users to save and reuse their CSV importer configuration as named templates. name: Import Templates - description: | Properties are the physical locations. name: Properties - description: | Search across schemes, work orders, and operations. name: Search - description: | Provides the API specification in JSON and YAML formats name: Specifications - description: | Streets are the physical roads. name: Streets - description: | Integration with street manager name: Street Manager - description: | Vehicles are the physical vehicles that an organisation manages. name: Vehicles - description: > Scheme contracts (also known as regions) group schemes allocated from the network to a contractor. name: Scheme Contracts - description: > Scheme shares allow you to share your schemes with other organisations across bridges. name: Scheme Shares - description: | Schemes are large programmes of work name: Schemes - description: > A Construction Phase Plan is the Principal Contractor's plan for managing health and safety on a scheme, under CDM 2015. Its risks are control measures written against the hazards on the scheme's Pre-Construction Information. Each section is owned by one duty-holder role. name: Construction Phase Plans - description: > A Pre-Construction Information pack is the Client's information about a scheme under CDM 2015, with its site hazards. A scheme has at most one. Each section is owned by one duty-holder role, and only that role can write it. name: Pre-Construction Information - description: > Site attendances record who was on site and when, whether or not they hold an account. There is no daily register resource: a day's register and who is currently on site are both queries over the attendances themselves. name: Site Attendances - description: | Work orders the component parts of a scheme. name: Work Orders - description: | Operations are the work to be carried out within work orders. name: Operations externalDocs: description: More documentation and resources url: https://docs.ctrl-hub.com paths: /v3/havs-exposures: post: tags: - Equipment summary: Record a HAVS exposure description: > Record a completed period of hand-arm vibration exposure against an HSE Table 1 category (`havs-equipment`). The category's recommended initial magnitude is copied onto the record, and points, A(8) and the trigger time are derived from it. A later change to the category does not restate the record. A category whose recommended initial magnitude is zero or less is refused. Its points, A(8) and trigger time would not be meaningful values. The subject defaults to the caller. Recording for someone else needs the `havs-exposures:create-on-behalf` permission, and the record keeps who recorded it. operationId: CreateHavsExposure requestBody: $ref: '#/components/requestBodies/CreateHavsExposure' responses: '201': $ref: '#/components/responses/GetHavsExposure' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - Cookie: [] - OAuth2: [] components: requestBodies: CreateHavsExposure: required: true description: The HAVS exposure to record. content: application/vnd.api+json: schema: type: object required: - data properties: data: type: object required: - type - attributes - relationships properties: type: type: string const: havs-exposures attributes: type: object required: - start_time - end_time - ppe properties: start_time: type: string format: date-time end_time: type: string format: date-time description: >- Must be after the start time and no more than 24 hours after it. The exposure must have ended, so this may be at most 5 minutes later than now. The 5 minutes allows for a device clock running fast. ppe: $ref: '#/components/schemas/HavsExposurePPE' location: description: >- Where the exposure took place. Omit or send null when no position is available. A zero point is rejected as a placeholder. A location naming neither british_national_grid nor lat_long, such as GeoJSON, is rejected. oneOf: - $ref: '#/components/schemas/GeoPoint' - type: 'null' relationships: type: object required: - organisation - havs_equipment properties: organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' havs_equipment: type: object required: - data properties: data: $ref: '#/components/schemas/HavsEquipmentRelationship' subject: type: object description: >- The person exposed. Defaults to the caller. Naming anyone else needs the havs-exposures:create-on-behalf permission. required: - data properties: data: $ref: '#/components/schemas/UserRelationship' responses: GetHavsExposure: description: Get a HAVS exposure. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: allOf: - type: object required: - data properties: data: $ref: '#/components/schemas/HavsExposure' - $ref: '#/components/schemas/JSONAPI' BadRequest: description: > There was an error with the request - this could be due to an invalid body, query parameters, or headers that were sent to the API. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 98ca4a78-b66f-4234-9719-aaf832ee6669 status: '400' title: A validation error was encountered source: parameter: include meta: resource: wrong_value Unauthorised: description: Authentication failed headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 05fc9c8d-73b9-4697-9337-57f7a567a48f status: '401' title: You are not authorised to access this resource detail: In order to access this resource, you need the 'admin' role. code: AUTH.001 NotFound: description: The requested resource could not be found headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f status: '404' title: Resource not found detail: The requested resource could not be found or does not exist. code: NOT_FOUND.001 InternalServerError: description: There was a problem handling the request on the server side headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: fe9d9a69-f0a7-4fdc-bb2c-176027f316c5 status: '500' title: Internal Server Error detail: An unexpected error occurred on the server. schemas: HavsExposurePPE: type: object description: The personal protective equipment worn during the exposure. required: - mask - ear_defenders properties: mask: type: boolean description: Whether a mask was worn. ear_defenders: type: boolean description: Whether ear defenders were worn. GeoPoint: type: object description: > A point on the ground, given in either British National Grid eastings and northings or in latitude and longitude. Supply one standard, not both. The platform stores what it is given and does not convert between the two, so a point carries the standard it was entered in and only that one is populated on read. Supplying both is rejected: choosing one would silently discard the other. Each coordinate must be complete. Half a coordinate locates nothing, and a missing member would otherwise be read as a zero, putting a pole in the Gulf of Guinea or off the Isles of Scilly. The `oneOf` below is what makes that rule part of the contract rather than only prose, so a generated client cannot construct a point the API refuses. The third branch is the point that carries neither standard, which is how an empty `{}` clears a coordinate. properties: british_national_grid: type: - object - 'null' required: - easting - northing properties: easting: type: number format: double northing: type: number format: double lat_long: type: - object - 'null' required: - latitude - longitude properties: latitude: type: number format: double longitude: type: number format: double oneOf: - title: BritishNationalGridPoint description: A point given in British National Grid eastings and northings. required: - british_national_grid properties: british_national_grid: type: object lat_long: type: 'null' - title: LatLongPoint description: A point given in latitude and longitude. required: - lat_long properties: lat_long: type: object british_national_grid: type: 'null' - title: NoPoint description: > Neither standard carries a coordinate, which clears the point rather than storing one. properties: british_national_grid: type: 'null' lat_long: type: 'null' OrganisationRelationship: type: object description: Represents a relationship to an organisation required: - id - type properties: id: type: string format: uuid description: The unique identifier of the organisation type: type: string const: organisations HavsEquipmentRelationship: type: object description: Represents a relationship to a HAVS equipment category (HSE Table 1) required: - id - type properties: id: type: string format: uuid description: The unique identifier of the HAVS equipment category type: type: string const: havs-equipment UserRelationship: type: object description: Represents a relationship to a user required: - id - type properties: id: type: string format: uuid description: The unique identifier of the user type: type: string const: users HavsExposure: type: object description: >- A completed period of hand-arm vibration exposure, recorded against an HSE Table 1 category. required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the HAVS exposure. type: type: string const: havs-exposures attributes: $ref: '#/components/schemas/HavsExposureAttributes' meta: $ref: '#/components/schemas/HavsExposureMeta' relationships: $ref: '#/components/schemas/HavsExposureRelationships' JSONAPI: type: object description: JSON API response object required: - jsonapi properties: jsonapi: type: object required: - version properties: version: type: string description: The version of the JSON API specification examples: - '1.0' Error: type: object description: An error response properties: id: description: >- A unique identifier for this particular occurrence of the problem. If you encounter this, please provide us with the error ID and we can investigate it on our side. type: string format: uuid examples: - 05fc9c8d-73b9-4697-9337-57f7a567a48f status: description: >- The status code for the error. This might not match the HTTP status code if there are more that one errors to return with different status codes. type: string examples: - '401' - '500' title: description: A human readable title for the error. type: string examples: - You are not authorised to access this resource detail: description: >- Where there is more detail that we can provide outside of the title, we will provide it here. type: string examples: - In order to access this resource, you need the 'admin' role. code: description: >- A unique code for the error that may help us to diagnose the issue. Not all errors have codes, so this is usually empty. `CH.003.080` (403) means the organisation in `meta.organisation_id` requires two-factor authentication and the caller's session does not satisfy it. The caller must set up or use a second factor, or sign in through their organisation's SAML single sign-on. Other OIDC sign-ins do not count. type: string examples: - AUTH.001 - CH.003.080 source: description: A JSON object containing additional information about the error. type: object properties: pointer: description: >- A JSON Pointer to the value in the request that caused the error. type: string examples: - /data/attributes/email parameter: description: >- A string indicating which query parameter in the request caused the error. type: string examples: - include meta: description: >- A JSON object containing additional information about the error. When a parameter caused the error, there will be a `resource` property with the name of the resource that caused the error. When `code` is `CH.003.080`, `organisation_id` names the organisation that requires two-factor authentication, which the caller's session does not satisfy. type: object properties: resource: type: string description: >- The resource a parameter error relates to, such as an unsupported include. organisation_id: type: string format: uuid examples: - c000c344-8847-47da-a091-32e75902d3b1 additionalProperties: true required: - id - status - title HavsExposureAttributes: type: object description: Attributes of a HAVS exposure required: - start_time - end_time - ppe - location - magnitude properties: start_time: type: string format: date-time description: When the exposure started. end_time: type: string format: date-time description: When the exposure ended. Always after the start time. ppe: $ref: '#/components/schemas/HavsExposurePPE' location: description: >- Where the exposure took place, or null when no position was available. oneOf: - $ref: '#/components/schemas/GeoPoint' - type: 'null' magnitude: type: number format: double readOnly: true description: >- The vibration magnitude in m/s², copied from the category's recommended initial value when the exposure was recorded. examples: - 5 HavsExposureMeta: type: object description: > Metadata for a HAVS exposure. Points, A(8) and the trigger time are derived on the server from the record's magnitude and duration (T, in hours). required: - points - a8 - trigger_time - created_at - updated_at properties: points: type: number format: double description: >- Exposure points, (magnitude / 2.5)² × (T / 8) × 100. 100 points is the exposure action value (EAV) and 400 the exposure limit value (ELV). examples: - 200 a8: type: number format: double description: The daily exposure A(8) in m/s², magnitude × √(T / 8). examples: - 3.54 trigger_time: type: number format: double description: >- Hours of use of this tool alone to reach the exposure action value (100 points), 8 × (2.5 / magnitude)². examples: - 2 created_at: type: string format: date-time updated_at: type: string format: date-time HavsExposureRelationships: type: object description: Relationships for a HAVS exposure required: - organisation - subject - recorded_by - havs_equipment properties: organisation: type: object description: The organisation the exposure belongs to. required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' subject: type: object description: The person who was exposed. required: - data properties: data: $ref: '#/components/schemas/UserRelationship' recorded_by: type: object description: >- The person who recorded the exposure. Server-derived, never accepted from a client. Differs from the subject when the exposure was recorded on someone's behalf. required: - data properties: data: $ref: '#/components/schemas/UserRelationship' havs_equipment: type: object description: The HSE Table 1 category of tool used. required: - data properties: data: $ref: '#/components/schemas/HavsEquipmentRelationship' headers: content-type: description: The content type of the response schema: type: string example: application/vnd.api+json content-length: description: The length of the response body in bytes schema: type: integer format: int32 example: 1234 x-request-id: description: >- An ID that can be provided when reporting bugs to help identify the issue schema: type: string example: 8470f56af4cf25e22be08e72c70dbbdc securitySchemes: Session: description: | Session token for authentication. in: header name: X-Session-Token type: apiKey Cookie: description: | Cookie token for authentication. in: cookie name: ctrl_hub_session type: apiKey OAuth2: description: | OAuth2 token for authentication. flows: clientCredentials: scopes: {} tokenUrl: https://auth.ctrl-hub.com/oauth2/token type: oauth2 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.