Quiz Question Groups API

BETA: This API resource is not finalized, and there could be breaking changes before its final release.

API for accessing information on quiz question groups

A QuizGroup object looks like:

{
  
  //The ID of the question group.
  "id": 1,
  
  //The ID of the Quiz the question group belongs to.
  "quiz_id": 2,
  
  //The name of the question group.
  "name": "Fraction questions",
  
  //The number of questions to pick from the group to display to the student.
  "pick_count": 3,
  
  //The amount of points allotted to each question in the group.
  "question_points": 10,
  
  //The ID of the Assessment question bank to pull questions from.
  "assessment_question_bank_id": 2,
  
  //The order in which the question group will be retrieved and displayed.
  "position": 1
}

Create a question group Quizzes::QuizGroupsController#create

BETA: This API endpoint is not finalized, and there could be breaking changes before its final release.

POST /api/v1/courses/:course_id/quizzes/:quiz_id/groups

Create a new question group for this quiz

201 Created response code is returned if the creation was successful.

Request Parameters:

  • quiz_groups[][name]
    Optional, String

    The name of the question group.

  • quiz_groups[][pick_count]
    Optional, Integer

    The number of questions to randomly select for this group.

  • quiz_groups[][question_points]
    Optional, Integer

    The number of points to assign to each question in the group.

  • quiz_groups[][assessment_question_bank_id]
    Optional, Integer

    The id of the assessment question bank to pull questions from.

Example Response:

{
  "quiz_groups": [QuizGroup]
}

Update a question group Quizzes::QuizGroupsController#update

BETA: This API endpoint is not finalized, and there could be breaking changes before its final release.

PUT /api/v1/courses/:course_id/quizzes/:quiz_id/groups/:id

Update a question group

Request Parameters:

  • quiz_groups[][name]
    Optional, String

    The name of the question group.

  • quiz_groups[][pick_count]
    Optional, Integer

    The number of questions to randomly select for this group.

  • quiz_groups[][question_points]
    Optional, Integer

    The number of points to assign to each question in the group.

Example Response:

{
  "quiz_groups": [QuizGroup]
}

Delete a question group Quizzes::QuizGroupsController#destroy

BETA: This API endpoint is not finalized, and there could be breaking changes before its final release.

DELETE /api/v1/courses/:course_id/quizzes/:quiz_id/groups/:id

Delete a question group

<b>204 No Content<b> response code is returned if the deletion was successful.

Reorder question groups Quizzes::QuizGroupsController#reorder

BETA: This API endpoint is not finalized, and there could be breaking changes before its final release.

POST /api/v1/courses/:course_id/quizzes/:quiz_id/groups/:id/reorder

Change the order of the quiz questions within the group

<b>204 No Content<b> response code is returned if the reorder was successful.

Request Parameters:

  • order[][id]
    Required, Integer

    The associated item's unique identifier

  • order[][type]
    "question"

    The type of item is always 'question' for a group