Healthier Business Group
Home
HB PortalRequest API access
Home
HB PortalRequest API access
X
Instagram
LinkedIn
  1. Training Requests
  • Walk through Healthier Business Group 🔵
  • Heathier Business Portal APIs V2
    • Authentication
      • Get access token
      • Refresh access token
      • Get token info
      • Revoke current token
    • Reference Requests
      • References
        • Get reference detail
        • Download reference PDF
      • List reference requests
      • Create reference request
      • Get reference request
      • Cancel reference request
      • Add referee to request
      • Send reminders
    • Candidate Requests
    • Training Requests
    • OH Requests
    • Practical Training Requests
    • BLS Requests
    • Appraisal Requests
    • Certificate Requests
    • Training Verification Requests
    • Webhooks
      • List webhook endpoints
      • Create webhook endpoint
      • Update webhook endpoint
      • Delete webhook endpoint
      • View webhook call logs
      • Send test webhook
    • Templates
      • List form templates
  • Heathier Business Portal APIs V1 - Deprecated
    • Candidate Requests
      • Get All Candidates
      • Get Candidate Data
      • Create New Candidate
      • Update Candidate Details
    • Training Requests
      • Get Available Trainings
        GET
      • Get Candidate Course Result
        GET
      • Get Candidate Training Report
        GET
      • Get Candidate Training Report - Unassigned
        GET
    • OH Requests
      • Get Available Forms
      • Get Form Fields
      • Creating a new submission
      • Modifying the details of an existing submission (Upload Documents)
      • Make final form submission (after uploading documents)
      • Get submission list
      • Retrieve submission result details
      • Retrieve the submission result documents for the employer
    • Certificates Requests
      • Get Training Certificate
      • Get Training Certificate - including expired
      • Get Training Certificate - including non-assigned courses, but excluding expired
      • Get Training Certificate - All available courses
      • Get Training Certificate - Specific Course
    • Webhooks
      • Training Completion
      • Course Completion
  • HB Services
    • List Interview Bookings
      GET
  • The Direct Training Academy
    • Bookings
      • Get Past Bookings
      • Get Upcoming Bookings
      • Search Bookings by Date
    • Booking Links
      • Search Booking Links
  • Schemas
    • Booking
    • TokenResponse
    • InterviewBooking
    • Pagination
    • BookingInvite
    • ReferenceRequest
    • BookingsResponse
    • Reference
    • BookingLinksResponse
    • ReferenceDetail
    • CreateReferenceRequest
    • RefereeInput
    • Template
    • WebhookEndpoint
    • CreateWebhookEndpoint
    • UpdateWebhookEndpoint
    • WebhookCall
    • WebhookPayload
    • PaginationMeta
    • PaginationLinks
    • Error
    • RateLimitError
    • ValidationError
  1. Training Requests

Get Candidate Training Report

GET
/training-results/{{candidate_ref}}
Maintainer:Not configured
The endpoint provides a method to retrieve status results for each course currently assigned to the candidate.
The requests are HTTP GET (RFC2616) and use candidate_ref as resource identifier, which is a UUID string, identifying the candidate uniquely at HB.

Request

Authorization
Add parameter in header
API-Key
Example:
API-Key: ********************

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/training-results/{{candidate_ref}}' \
--header 'API-Key: <api-key>'

Responses

🟢200Get Candidate Training Report
application/json
Body

Example
[
    {
        "courses": [
            {
                "course_id": "56",
                "course_name": "Basic Life Support Video Link Practical Training",
                "date_assigned": "2023-02-07 12:55:38",
                "date_completed": "",
                "renewal_date": "",
                "course_status": "",
                "grade": ""
            },
            {
                "course_id": "74",
                "course_name": "Basic Literacy",
                "date_assigned": "2022-10-18 13:22:59",
                "date_completed": "",
                "renewal_date": "",
                "course_status": "",
                "grade": ""
            },
            {
                "course_id": "75",
                "course_name": "Basic Numeracy",
                "date_assigned": "2022-10-18 13:22:59",
                "date_completed": "2022-12-06 13:17:18",
                "renewal_date": "2023-12-06 13:17:18",
                "course_status": "1",
                "grade": "0.9000"
            }
        ]
    }
]
Modified at 2024-08-09 12:13:51
Previous
Get Candidate Course Result
Next
Get Candidate Training Report - Unassigned
Built with