Session Students

Update or rate session for a student

Changed on

Update the rating for a specific category in a session-student relationship

patch/session_students

Request

  • Base URL: http://localhost:8080/api/v1
  • URL: http://localhost:8080/api/v1/session_students
  • Auth: none declared

Request body

session_idstring uuid required

UUID of the session (cannot be changed)

student_idstring uuid required

UUID of the student (cannot be changed)

presentboolean

Update the student's attendance status

notesstring nullable

Update or clear notes (set to null to clear)

Example request

{
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "student_id": "987fcdeb-51a2-43d1-9f4c-123456789abc",
  "notes": "Student left early due to appointment",
  "ratings": [
    {
      "category": "engagement",
      "level": "high",
      "description": "Student was highly engaged throughout the session"
    }
  ]
}

Response

Session rated successfully

session_idstring uuid required

UUID of the session (cannot be changed)

student_idstring uuid required

UUID of the student (cannot be changed)

presentboolean

Update the student's attendance status

notesstring nullable

Update or clear notes (set to null to clear)

Example response

{
  "session_id": "123e4567-e89b-12d3-a456-426614174000",
  "student_id": "987fcdeb-51a2-43d1-9f4c-123456789abc",
  "notes": "Student left early due to appointment",
  "ratings": [
    {
      "category": "engagement",
      "level": "high",
      "description": "Student was highly engaged throughout the session"
    }
  ]
}

Changes

    • ○

      the request property became optional

    • ▲

      added the new required request property

    • ▲

      the response property became optional for the status

    • ▲

      removed the required property from the response with the status

    • ▲

      removed the required property from the response with the status

    • ○

      added the required property to the response with the status