Path parameters

• classId string Required

  The class ID

Query parameters

• startDate string(date)

  Start date for the schedule range

• endDate string(date)

  End date for the schedule range

Responses

• 200 application/json

  Schedule retrieved successfully

  Hide response attributes Show response attributes object

  • success boolean
  • code integer(int32)
  • message string
  • data array[object]

    Daily schedule object containing all periods for a specific date

    Hide data attributes Show data attributes object

    • date string(date)

      Date of the schedule (YYYY-MM-DD)

    • classId string

      ID of the class

    • periods array[object]

      List of periods for this date

      Schedule period representing a scheduled event or class period on a specific date (non-recurring)

      Hide periods attributes Show periods attributes object

      • id string

        Unique identifier for the period

      • classId string

        ID of the class

      • name string

        Name of the period or event

      • subject string

        Subject code being taught

      • date string(date)

        Date of the period (YYYY-MM-DD)

      • startTime string(time) | null

        Start time of the period (HH:mm)

      • endTime string(time) | null

        End time of the period (HH:mm)

      • category string

        Category of the period

        Values are assignment, exam, fieldTrip, meeting, holiday, presentation, or other.

      • location string | null

        Location of the period

      • description string | null

        Description of the period

      • isActive boolean

        Whether the period is active

      • lessons array[object] | null

        Lesson plan object representing a detailed plan for teaching or assignment

        Hide lessons attributes Show lessons attributes object

        • id string Required

          Unique identifier for the lesson

        • classId string Required

          ID of the class

        • authorId string Required

          ID of the teacher/author

        • title string Required

          Title of the lesson

          Maximum length is 200.

        • subject string | null

          Subject code (e.g., Math-1)

        • content string Required

          Lesson content or instructions

        • type string

          Type of lesson

          Values are assignment, material, lecture, or quiz.

        • status string

          Status of the lesson

          Values are draft, published, or archived.

        • learningObjectives array[object] | null

          Array of learning objectives

          Hide learningObjectives attributes Show learningObjectives attributes object

          • description string
          • type string
          • isAchieved boolean
          • notes string | null
        • lessonPlan string | null

          Private teacher notes/plan (not visible to students)

        • maxPoints integer | null

          Maximum points for assignments

        • dueDate string(date-time) | null

          Due date for assignments

        • createdAt string(date-time)

          Timestamp when the lesson was created

        • updatedAt string(date-time)

          Timestamp when the lesson was last updated

      • createdAt string(date-time)

        Timestamp when the period was created

      • updatedAt string(date-time)

        Timestamp when the period was last updated

• 404 application/json

  Class not found

  Hide response attributes Show response attributes object

  • success boolean
  • code integer
  • errorCode string
  • message string
  • timestamp string(date-time)
• 500 application/json

  Internal Server Error

  Hide response attributes Show response attributes object

  • success boolean
  • code integer
  • errorCode string
  • message string
  • timestamp string(date-time)