Skip to main content

Creating a Learning Record​


We now have created, and enrolled learners in a new class. The final step will be to assign a grade to each learner by creating a learning record. This endpoint accepts the "learnerId", a "grade" of either "PASSED" or "FAILED", and "notes" where additional comments can be provided.

Request Body Example and Schema

      {
        "learnerId": "string",
        "grade": "PASSED",
        "notes": "string"
      }


Getting a list of enrolled learners in a class​


By calling this endpoint we can confirm which learners have been enrolled in the class and retrieve useful information about them such as the "enrollmentId", and information about the learner such as their "id", "firstname", "lastname", "contact" information, as well as "employer" information.

Responses Example

        [
          {
            "id": "string",
            "learner": {
              "id": "string",
              "firstname": "string",
              "lastname": "string",
              "uniqueSystemIdentifier": "string",
              "email": "string",
              "phone": "string"
            },
            "employer": {
              "id": "string",
              "name": "string"
            }
          }
        ]


Verfying learning records for a class​


Check the learning records for a class by calling this endpoint. The response will return an array of learning records with information including the "learningRecordId", "result" as well as information about the "learner"

Responses Example

        [
          {
            "id": "string",
            "result": "PASSED",
            "notes": "string",
            "learner": {
              "id": "string",
              "firstname": "string",
              "lastname": "string",
              "email": "string",
              "phone": "string"
            }
          }
        ]



This concludes the use case guide for the SkillsPass Training Provider API. Navigate our API Reference from the sidebar for detailed documentation on all of the endpoints.​