API for accessing and building New Quizzes. To interact with New Quiz items, see the New Quiz Items API.
A NewQuiz object looks like:
{// the ID of the quiz"id": "5",// the title of the quiz"title": "Hamlet Act 3 Quiz",// the quiz's instructions"instructions": "<p>Welcome to the final exam for...</p>",// the ID of the quiz's assignment group"assignment_group_id": "3",// The total point value given to the quiz"points_possible": 20,// when the quiz is due"due_at": "2013-01-23T23:59:00-07:00",// when to lock the quiz"lock_at": null,// when to unlock the quiz"unlock_at": "2013-01-21T23:59:00-07:00",// whether the quiz has a published or unpublished draft state"published": true,// the type of grading the assignment receives ('pass_fail', 'percent',// 'letter_grade', 'gpa_scale', or 'points')"grading_type": "points",// additional quiz settings (see QuizSettings)"quiz_settings": null}
A QuizSettings object looks like:
{// type of calculator the user will have access to during the quiz ('none',// basic' or 'scientific')"calculator_type": "scientific",// whether access to the quiz should be restricted to the IP address ranges// described in 'filters'"filter_ip_address": true,// IP address ranges from which users can take the quiz, if 'filter_ip_address'// is true"filters": {"ips":[["1.1.1.1","1.1.1.3"],["2.2.2.3","2.2.2.9"]]},// whether questions should be shown all at once ('none') or one-at-a-time// ('question')"one_at_a_time_type": "none",// whether to allow user to return to previous questions when// 'one_at_a_time_type' is set to 'question'"allow_backtracking": false,// whether answers should be shuffled during quiz"shuffle_answers": false,// whether questions should be shuffled during quiz"shuffle_questions": false,// whether to require an access code to take the quiz (set as// 'student_access_code')"require_student_access_code": true,// access code that is required to take the quiz if// 'require_student_access_code' is true"student_access_code": "supersecret",// whether the quiz has a time limit (set as 'session_time_limit_in_seconds')"has_time_limit": true,// time limit during the quiz (in seconds)"session_time_limit_in_seconds": 3600,// settings to configure multiple quiz attempts (see MultipleAttemptsSettings)"multiple_attempts": null,// settings to restrict student result view (see ResultViewSettings)"result_view_settings": null}
A MultipleAttemptsSettings object looks like:
{// whether to allow multiple attempts"multiple_attempts_enabled": true,// whether to limit the number of attempts if 'multiple_attempts_enabled' is// true. Unlimited attempts if false."attempt_limit": true,// number of attempts to allow if 'multiple_attempts_enabled' and// 'attempt_limit' are true"max_attempts": 3,// specifies which score to keep after attempts ('average', 'first', 'highest',// or 'latest')"score_to_keep": "highest",// whether to enforce a waiting period after an attempt (set as// 'cooling_period_seconds')"cooling_period": true,// required waiting period (in seconds) between attempts. Enforced if// 'cooling_period' is true."cooling_period_seconds": 1800}
A ResultViewSettings object looks like:
{// whether to restrict the student result view"result_view_restricted": true,// whether to show points awarded (overall and per question), if// 'result_view_restricted' is true"display_points_awarded": true,// whether to show points possible (overall and per question), if// 'result_view_restricted' is true"display_points_possible": true,// whether to show questions in the result view, if 'result_view_restricted' is// true"display_items": true,// whether to show student's responses in the result view, if 'display_items' is// true"display_item_response": true,// whether student responses should be shown for all attempts ('always'), only// once after each attempt ('once_per_attempt'), only after their last attempt// ('after_last_attempt'), or only once after their last attempt// ('once_after_last_attempt'). if 'display_item_response' is true"display_item_response_qualifier": "always",// when student responses should be shown to them, if 'display_item_responses'// is true"show_item_responses_at": "2024-06-20T20:00:00.000-06:00",// when student responses should be hidden from them, if// 'display_item_responses' is true. must be later than 'show_item_responses_at'"hide_item_responses_at": "2024-06-21T20:00:00.000-06:00",// whether to indicate whether the student's response is correct/incorrect, if// 'display_item_response' is true"display_item_response_correctness": true,// whether student response correctness should be shown for all attempts// ('always') or only after their last attempt ('after_last_attempt'), if// 'display_item_response_correctness' is true"display_item_response_correctness_qualifier": "always",// when correctness of student responses should be shown to them, if// 'display_item_response_correctness' is true"show_item_response_correctness_at": "2024-06-20T20:00:00.000-06:00",// when correctness of student responses should be hidden from them, if// 'display_item_response_correctness' is true. must be later than// 'show_item_response_correctness_at'"hide_item_response_correctness_at": "2024-06-21T20:00:00.000-06:00",// whether to show the correct answer for each question, if// 'display_item_response_correctness' is true"display_item_correct_answer": true,// whether to show feedback for each item, if 'display_items' is true"display_item_feedback": true}
Specifies which type of Calculator a student can use during Quiz taking. Should be null if no calculator is allowed.
Allowed values: none, basic, scientific
quiz[quiz_settings][filter_ip_address]
boolean
Whether IP filtering is needed. Must be true for filters to take effect.
quiz[quiz_settings][filters][ips][]
string
Specifies ranges of IP addresses where the quiz can be taken from. Each range is an array like [start address, end address], or null if there’s no restriction.
Whether item response is shown. Only set if display_items is true. Must be true for display_item_response_qualifier, show_item_responses_at, hide_item_responses_at, and display_item_response_correctness to be set.
Whether item correctness is shown. Only set if display_item_response is true. Must be true for display_item_response_correctness_qualifier, show_item_response_correctness_at, hide_item_response_correctness_at and display_item_correct_answer to be set.
Specifies which type of Calculator a student can use during Quiz taking. Should be null if no calculator is allowed.
Allowed values: none, basic, scientific
quiz[quiz_settings][filter_ip_address]
boolean
Whether IP filtering is needed. Must be true for filters to take effect.
quiz[quiz_settings][filters][ips][]
string
Specifies ranges of IP addresses where the quiz can be taken from. Each range is an array like [start address, end address], or null if there’s no restriction. Specifies the range of IP addresses where the quiz can be taken from. Should be null if there’s no restriction.
Whether item response is shown. Only set if display_items is true. Must be true for display_item_response_qualifier, show_item_responses_at, hide_item_responses_at, and display_item_response_correctness to be set.
Whether item correctness is shown. Only set if display_item_response is true. Must be true for display_item_response_correctness_qualifier, show_item_response_correctness_at, hide_item_response_correctness_at and display_item_correct_answer to be set.
