Healthier Business Group
Home
HB PortalRequest API access
Home
HB PortalRequest API access
X
Instagram
LinkedIn
  1. Certificates 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 Candidate Course Result
      • Get Candidate Training Report
      • Get Candidate Training Report - Unassigned
    • 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
      • Get Training Certificate - including expired
        GET
      • Get Training Certificate - including non-assigned courses, but excluding expired
        GET
      • Get Training Certificate - All available courses
        GET
      • Get Training Certificate - Specific Course
        GET
    • 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. Certificates Requests

Get Training Certificate - Specific Course

GET
/training-results/{{candidate_ref}}/certificate/course/{{course_id}}
Maintainer:Not configured
The endpoint provides a method to retrieve a PDF training certificate for a candidate for an individual course.
The URI format is: https://hb-host.tld/api/training-results/{{candidate_ref}}/certificate/course/{{course_id}}
The requests are HTTP GET (RFC2616) and use candidate_ref as resource identifier, which is a UUID string, identifying the candidate uniquely at HB.
If the candidate_ref is not valid then the API should response with HTTP 404 Not Found error.
If there is no certificate available for the course, the API should send an HTTP 204 No Content response.

Request

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

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}}/certificate/course/{{course_id}}' \
--header 'Accept: application/pdf' \
--header 'API-Key: <api-key>'

Responses

🟢200Success
application/json
Body

Example
{}
Modified at 2024-08-09 12:16:30
Previous
Get Training Certificate - All available courses
Next
Training Completion
Built with