Occupational Health

Overview

• A Fit to Work certificate or fail letter was added to a requestoccupational-health.document.available
• A candidate was sent a renewal reminderoccupational-health.renewal.due
• A request is waiting for the candidate to complete the questionnaireoccupational-health.request.awaiting_candidate
• A request ended in a fail (not fit)occupational-health.request.fail
• Full clearance was issuedoccupational-health.request.full_clearance
• The candidate completed the online questionnaireoccupational-health.request.questionnaire_completed
• A request was rejectedoccupational-health.request.rejected
• A request was submitted to Healthier Businessoccupational-health.request.submitted
• Temporary clearance was issuedoccupational-health.request.temporary_clearance
• GETList alerts/api/v2/occupational-health/alerts
• POSTDismiss all alerts/api/v2/occupational-health/alerts/clear
• POSTDismiss one alert/api/v2/occupational-health/alerts/dismiss
• GETList candidates/api/v2/occupational-health/candidates
• GETGet a candidate with their request history/api/v2/occupational-health/candidates/{candidate_ref}
• POSTSend the health questionnaire reminder email/api/v2/occupational-health/candidates/{candidate_ref}/reminder
• GETList clearance types/api/v2/occupational-health/clearance-types
• GETGet the questionnaire of a clearance type/api/v2/occupational-health/clearance-types/{clearance_type}/questionnaire
• GETGet the credit balance/api/v2/occupational-health/credits
• GETList credit packages/api/v2/occupational-health/credits/packages
• GETList credit transactions/api/v2/occupational-health/credits/transactions
• GETList questionnaires/api/v2/occupational-health/forms
• GETGet one questionnaire/api/v2/occupational-health/forms/{shortcode}
• GETGet the Occupational Health account/api/v2/occupational-health/profile
• GETList the reports/api/v2/occupational-health/reports
• POSTStart generating a report/api/v2/occupational-health/reports/{type}/generate
• GETDownload a generated report/api/v2/occupational-health/reports/{type}/{format}
• GETGet the choices and upload limits of a new request/api/v2/occupational-health/request-options
• GETList requests/api/v2/occupational-health/requests
• POSTCreate a request/api/v2/occupational-health/requests
• GETDownload the requests as a CSV file/api/v2/occupational-health/requests/export
• GETGet the request counts/api/v2/occupational-health/requests/stats
• GETGet one request/api/v2/occupational-health/requests/{id}
• GETList the questionnaire answers of a request/api/v2/occupational-health/requests/{id}/answers
• GETList the documents of a request/api/v2/occupational-health/requests/{id}/documents
• GETDownload a supporting document/api/v2/occupational-health/requests/{id}/documents/{file}
• GETDownload a Fit to Work certificate or fail letter/api/v2/occupational-health/requests/{id}/ftw/{ftw}
• GETGet the questionnaire of a request/api/v2/occupational-health/requests/{id}/questionnaire
• POSTSubmit the answers to a questionnaire for a candidate/api/v2/occupational-health/requests/{id}/questionnaire/{shortcode}/answers
• GETGet the Occupational Health settings/api/v2/occupational-health/settings
• POSTCreate an embed session for a health questionnaire/api/v2/occupational-health/embed/sessions
• POSTRefresh an embed session/api/v2/occupational-health/embed/sessions/{session_id}/refresh