CreateClassLearningRecord
POST /tp-api/classes/:classId/learning-records
Submit a learning record for a class.
Path Parameters
- classId string required
Class ID
Header Parameters
- training-provider-id string required
- application/json
Request Body required
- learnerId string required
Learner ID
- grade string required
Possible values: [
PASSED
,FAILED
,N/A
]Learner grade. PASSED or FAILED will create an attendance record with PRESENT status. N/A will create an attendance record with ABSENT status.
- notes string
Additional notes
Responses
- 200
- 400
Default Response
- application/json
- Schema
- Example (from schema)
Schema
attendance object required
id string requiredAttendance record ID.
attendance string requiredPossible values: [
PRESENT
,ABSENT
]Attendance status.
grade object
id string requiredGrade record ID.
result string requiredPossible values: [
PASSED
,FAILED
]Grade result.
notes stringGrade notes.
{
"attendance": {
"id": "string",
"attendance": "PRESENT"
},
"grade": {
"id": "string",
"result": "PASSED",
"notes": "string"
}
}
Default Response
- application/json
- Schema
- Example (from schema)
Schema
- anyOf
- MOD1
- MOD2
errors object[] required
Array [key string requiredError key
message string requiredError message
]statusCode number requiredcode stringError code
error string requiredError key
message string requiredError message
{
"errors": [
{
"key": "string",
"message": "string"
}
]
}
Loading...