edubridge learning management system
GET /api/v1/unit-offerings/by-semester/{semesterId}

Retrieve all unit offerings for a specific semester.

Path parameters

  • semesterId string Required

    Semester ID

Responses

  • 200 application/json

    Unit offerings for semester retrieved successfully

    Hide response attributes Show response attributes object
    • message string Required

      Response message

    • total number Required

      Total number of unit offerings

    • offerings array[object] Required

      List of unit offerings

      Hide offerings attributes Show offerings attributes object
      • id string Required

        Unit offering ID

      • Code string Required

        Unit offering code

      • unitVersionId string Required

        Unit version ID

      • courseIntakeId string Required

        Course intake ID

      • lecturerId string Required

        Lecturer ID

      • semesterId string Required

        Semester ID

      • personalizedOutline string

        Personalized outline

      • studentGroupingsEnabled boolean Required

        Whether student groupings are enabled

      • createdAt string Required

        Creation timestamp

      • updatedAt string Required

        Last update timestamp
  • 400 application/json

    Default bad request error 400 response

    Hide response attributes Show response attributes object
    • message string Required

      Response message

    • error string Required
    • statusCode number Required
  • 401

    Authentication required

  • 403

    Admin or Lecturer privileges required

GET /api/v1/unit-offerings/by-semester/{semesterId} 
curl \
 --request GET 'http://localhost:3500/api/v1/unit-offerings/by-semester/semester-uuid'
Response examples (200) 
{
  "message": "string",
  "total": 15,
  "offerings": [
    {
      "id": "uuid-string-here",
      "Code": "CS101-2024-1",
      "unitVersionId": "uuid-string-here",
      "courseIntakeId": "uuid-string-here",
      "lecturerId": "uuid-string-here",
      "semesterId": "uuid-string-here",
      "personalizedOutline": "Custom outline for this offering...",
      "studentGroupingsEnabled": false,
      "createdAt": "2024-09-01T10:30:00Z",
      "updatedAt": "2024-09-15T14:20:00Z"
    }
  ]
}
Response examples (400) 
{
  "message": "string",
  "error": "string",
  "statusCode": 42.0
}