Teacher Courses

Get Teacher Course Details

Changed on

Get the full details of a teacher course. Only returns courses where _id matches, user_id matches the current teacher, and is_teacher_course=True. Also allows admin users to access holiday workbook courses.

get/teacher/courses/{course_id}

Request

  • Base URL: https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.excellence-ai.com/teacher/courses/{course_id}
  • Auth: OAuth 2 (password, token URL api/login)

Path parameters

course_idstring required

Response

Successful Response

_idstring
user_idstring required
is_teacher_courseboolean
folder_idstring nullable
titlestring required
subjectstring nullable
status'UPLOADING' | 'PROCESSING_IMAGES' | 'STRUCTURING' | 'GENERATING_CONTENT' | 'COMPLETED' | 'FAILED'
original_image_pathsstring[]
raw_content_blobstring nullable
generated_course_contentstring nullable
revision_deck_status'GENERATING' | 'COMPLETED' | 'FAILED' nullable
knowledge_quiz_status'GENERATING' | 'COMPLETED' | 'FAILED' nullable
append_status'GENERATING' | 'COMPLETED' | 'FAILED' nullable
append_started_atstring date-time nullable
append_error_messagestring nullable
error_messagestring nullable
warningsstring[] nullable
figures_cropobject nullable
processing_optionsobject nullable
source_type'student_upload' | 'teacher_assigned' | 'holiday_workbook' | 'excellence_course' nullable
excellence_course_keystring nullable
excellence_content_signaturestring nullable
excellence_unmodifiedboolean nullable
holiday_course_contextobject nullable
created_atstring date-time
updated_atstring date-time

Changes

  • 7925dd21e4d0Revision changes
    • warning

      added the new excellence_course enum value to the / response property for the response status

    • warning

      added the new interactive enum value to the ////// response property for the response status

    • warning

      added the new video enum value to the ////// response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • c81ed506912fRevision changes
    • info

      added the optional property /// to the response with the status