Get Candidate Course Result

GET

/training-results/{{candidate_ref}}/course/{{course_id}}

Last modified:2024-08-09 12:13:38

Maintainer:Not configured

The endpoint provides a method to retrieve the status of an individual course whether currently assigned or not. The requests are HTTP GET (RFC2616) and uses candidate_ref as a resource identifier identifying the candidate uniquely at HB and the course_id to identify the course for which the status is requested.

If the candidate_ref is unknown the response should be HTTP 404 Not Found.
If there’s no historical data from a previous assignment, the API should send an HTTP 204 No Content response.

NOTE: API will return all dates in GMT (UTC+0) timezone only.

Request

Authorization

Add parameter in header

API-Key

Example:

API-Key: ********************

Responses

🟢200Get Candidate Course Result

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff '/training-results/{{candidate_ref}}/course/{{course_id}}' \
--header 'API-Key: <api-key>'

Response Example

[
    {
        "course": {
            "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",
            "grade": "0.9000",
            "course_status": "complete"
        }
    }
]

Modified at 2024-08-09 12:13:38

Get Available Trainings

Get Candidate Training Report