ListClassLearningRecords

GET /tp-api/classes/:classId/learning-records

Get a list of learning records for the given class.

Path Parameters

• classId string required

  Class ID

Query Parameters

• cursor string

  Cursor to return items after a specific position in the list.

• limit integer

  Possible values: >= 1 and <= 100

  Default value: 10

  Maximum number of items to return.

• skip integer

  Query to retrieve the items starting from that position in the dataset.

Header Parameters

• training-provider-id string required

Responses

• 200
• 400

---

Default Response

application/json

Schema

Schema

• Array [
• id string required

  Learning record ID

• result string required

  Possible values: [PASSED, FAILED]

  Learner grade

• notes string

  Additional notes

• learner object required

  id string required

  Learner ID

  firstname string

  Learner firstname.

  lastname string

  Learner lastname.

  email string

  Learner email.

  phone string

  Learner phone.

• ]

Example (from schema)

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

Default Response

application/json

Schema

Schema

• anyOf
  MOD1
• statusCode number required
• code string

  Error code

• error string required

  Error key

• message string required

  Error message

error object required

key string required

Error key

message string required

Error message

{
  "statusCode": 0,
  "code": "string",
  "error": "string",
  "message": "string"
}