Versions Compared

Key

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

...

MethodDescriptionAccess
GET

Retrieve a list of threads. course_id must be specified. topic_id, following, and text_search are mutually exclusive. In addition to pagination information and results, the returned object may include a text_search_rewrite field indicating that the text search query was rewritten (which happens automatically if the search has no matching results).

Query Parameters:

  • course_id (String): Retrieve threads only within the course
  • topic_id (String): Retrieve thread only within the topic
  • following (Boolean, must be true): Retrieve only threads the user is following
  • view (String, must be unread, or unanswered): Retrieve only threads the user is following, unread threads , or unanswered question threads, respectively
  • text_search (String): Retrieve only threads matching the given text or with comments matching the given text. Note that threads containing comments that match the search string will be returned even though the matching children are not included in the result payload.
  • order_by (String, must be one of "last_activity_at", "comment_count", "vote_count"): Order threads by most recent activity, most descendant comments, or most votes, respectively.
  • page_size (Integer, must be positive): Number of threads per page, with a maximum value TBD
  • page (Integer, must be non-negative): Page number to retrieve
Any role; flagged parameter is only respected for privileged users
POST

Create a new thread. Parameters as per initializability noted in model. If the user does not have a privileged role, and the topic identified by topic_id is cohorted, the new thread's group_id will be automatically initialized to the id of the user's cohort. If ther user has a privileged role, the specified group_id (or lack thereof) will be respected.

Required Body Parameters:

  • course_id
  • topic_id
  • type
  • title
  • raw_body
Any role, subject to blackouts

...