Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

FieldDescription
idString. The identifier of the course.
blackoutsList of Objects. A list of intervals during which users without a privileged role may not post. Each interval is an object containing "start" and "end" fields, where each value is an ISO 8601 String.
thread_list_urlString. The URL of the list of all threads in the course.
following_thread_list_urlString. The URL of the list of the user's followed threads in the course
topics_urlString. The URL of the topic listing for the course.
cohortsList of Objects. A list of cohorts in the course (if the course is cohorted). Each cohort is an object containing a "group_name" string field and a "group_id" integer field.

Topic Tree

Note: This representation of topics is read only.

...

Code Block
languagejs
titleGET /api/discussion/v1/courses/course-v1:TestX+TestCourse+TestRun/
{
  "id": "course-v1:TestX+TestCourse+TestRun",
  "discussions_enabled": true,
  "blackouts": [{"s tartstart": "2015-04-15T00:00:00Z", "end": "2015-04-22T00:00:00Z"}],
  "thread_list_url": "https://openedx.example.com/api/discussion/v1/threads/?course_id=course-v1:TestX+TestCourse+TestRun",
  "following_thread_list_url": "https://openedx.example.com/api/discussion/v1/threads/?course_id=course-v1:TestX+TestCourse+TestRun&following=1",
  "flagged_thread_list_url": "https://openedx.example.com/api/discussion/v1/threads/?course_id=course-v1:TestX+TestCourse+TestRun&abuse_flagged=1",
  "topics_url": "https://openedx.example.com/api/discussion/v1/course_topics/course-v1:TestX+TestCourse+TestRun/",
  "cohorts": [{"group_id": 1, "group_name": "Cohort One"}, {"group_id": 2, "group_name": "Cohort Two"}]
}

Anchor
course-topics-endpoint
course-topics-endpoint
/api/discussion/v1/course_topics/{course_id}/

...