edubase_post_exam_settings
Update individual exam settings, covering grading, time limits, results viewing, and export options. Surveys only support export format and sorting.
Instructions
Change individual settings of an exam. The columns of the export (every setting from export_stats on) cannot be configured for surveys, only the export_format and the export_sort settings are available for them. The export_attendance setting is read only, the attendance is configured together with its source on the interface.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| exam | Yes | exam identification string | |
| archive | No | allow archiving the users who already have a result, only available for the managers of the exam | |
| grading | No | grading of the exam, the code of a grading preset (see edubase_get_quiz_grading_presets), "none" to disable grading, or "default" to use the setting of the Quiz set, not available for surveys as they are never graded | |
| pausable | No | allow tests to be paused and continued later during the exam period, only available for non-blocking exams and always true for homeworks, cannot be disabled when some tests are currently paused, automatically disabled when nonblocking is disabled | |
| roundtime | No | time limit of a single question in seconds, overriding the setting of the Quiz set, only available for turn based (TURNS mode) Quiz sets. Accepts a number or a numeric string, 0 if there is no time limit, or "default" if the setting of the Quiz set should be used | |
| timelimit | No | time limit of the whole test in seconds, overriding the setting of the Quiz set. Accepts a number or a numeric string, 0 if there is no time limit, or "default" if the setting of the Quiz set should be used | |
| hide_grade | No | hide the grade on the results page, can only be enabled together with hide_points, always enabled with the none type | |
| export_sort | No | ordering of the examinees in the exported results file (default: the same order they are listed in on the users page of the exam, name: by the name of the examinees), default: default | |
| hide_points | No | hide the points during the test and on the results page, always enabled with the none type | |
| nonblocking | No | exam accounts are exclusively assigned to the exam and cannot be assigned to other exams during the exam period, always true for homeworks and surveys, cannot be disabled when the exam already has results or when some tests are currently paused | |
| export_stats | No | export the statistics of every question, not available for surveys (default: false) | |
| freeze_round | No | freeze the current round of the exam, so the Quiz set cannot be replaced and no new round can be started, only available for the managers of the exam | |
| results_page | No | redirect the examinees to the results page after the test, can only be disabled with the datetime_blind, manual and none types | |
| view_results | No | when the examinees can see their results (after: right after the test is submitted, until the end of the exam, always: any time during the exam period, the examinees can log back in to see their results, datetime: after the test is submitted, and again from the start of the results viewing period, datetime_blind: only in the results viewing period, the solutions and the details of the evaluation are hidden right after the test, manual: only after the result is published separately, test by test, none: never), not available for surveys (default: after) | |
| export_format | No | format of the exported results file (csv: semicolon separated values, xlsx: Excel 2007+ workbook), default: xlsx | |
| export_gender | No | export the gender of the registered examinees, needs special privileges to enable, not available for surveys (default: false) | |
| export_points | No | export the points scored on every question, not available for surveys (default: false) | |
| export_skills | No | export the skill results of the examinees, only exported when the Quiz set of the exam has skills, not available for surveys (default: true) | |
| export_answers | No | export the answers given by the examinees, not available for surveys (default: false) | |
| export_suspicion | No | export the suspicious test taking indicator, not available for surveys (default: false) | |
| show_in_lasthour | No | only show the results in the last hour of the exam, only available with the after type | |
| grading_threshold | No | threshold of the grading in percentage, between 0 and 100, only available for grading presets with a configurable threshold (of the go-nogo-custom type), can be changed without selecting the grading preset again | |
| view_results_start | No | start of the results viewing period (in YYYY-MM-DD HH:ii:ss format), only available with the datetime and datetime_blind types where it is mandatory, has to be between the start and the end of the exam, no further tests and no new rounds can be started once the period has begun | |
| hide_ingame_results | No | hide the results while the test is taken | |
| export_custom_fields | No | export the user data fields filled in by the examinees (see edubase_get_exam_fields), not available for surveys (default: true) | |
| export_finished_only | No | only export the examinees who finished their test, not available for surveys (default: false) | |
| view_results_identifier | No | label of the unique free text custom user data field the examinees can look up their results with, only available with the datetime and datetime_blind types, the field has to be a unique free text (text, email or phone) custom field of the exam (see edubase_get_exam_fields), send "none" (or an empty value) to disable the identifier based results page |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| exam | Yes | exam identification string | |
| archive | Yes | the users who already have a result can be archived | |
| grading | No | grading of the exam, the code of the grading preset in use, "custom" for a manually configured grading, or "none" when grading is disabled, null if the setting of the Quiz set is used (never returned for surveys) | |
| pausable | Yes | tests can be paused and continued later during the exam period | |
| roundtime | Yes | time limit of a single question in seconds (as a number), turn based Quiz sets only, null if the setting of the Quiz set is used, or 0 if there is no time limit | |
| timelimit | Yes | time limit of the whole test in seconds (as a number), null if the setting of the Quiz set is used, or 0 if there is no time limit | |
| hide_grade | No | the grade is hidden on the results page | |
| export_sort | Yes | ordering of the examinees in the exported results file (default: the same order they are listed in on the users page of the exam, name: by the name of the examinees) | |
| hide_points | No | the points are hidden during the test and on the results page | |
| nonblocking | Yes | exam accounts are exclusively assigned to the exam and cannot be assigned to other exams during the exam period | |
| results_url | No | URL where examinees can look up their own results with the identifier (only present if the identifier based results page is available) | |
| export_stats | No | the statistics of every question are exported (never returned for surveys) | |
| freeze_round | Yes | the current round of the exam is frozen, no new round can be started | |
| results_page | No | the examinees are redirected to the results page after the test | |
| view_results | No | when the examinees can see their results (after: right after the test is submitted, until the end of the exam, always: any time during the exam period, the examinees can log back in to see their results, datetime: after the test is submitted, and again from the start of the results viewing period, datetime_blind: only in the results viewing period, the solutions and the details of the evaluation are hidden right after the test, manual: only after the result is published separately, test by test, none: never), never returned for surveys | |
| export_format | Yes | format of the exported results file (csv: semicolon separated values, xlsx: Excel 2007+ workbook) | |
| export_gender | No | the gender of the registered examinees is exported (never returned for surveys) | |
| export_points | No | the points scored on every question are exported (never returned for surveys) | |
| export_skills | No | the skill results of the examinees are exported, only exported when the Quiz set of the exam has skills (never returned for surveys) | |
| export_answers | No | the answers given by the examinees are exported (never returned for surveys) | |
| export_suspicion | No | the suspicious test taking indicator is exported (never returned for surveys) | |
| show_in_lasthour | No | the results are only shown in the last hour of the exam | |
| export_attendance | No | the attendance of the examinees is exported, read only as the attendance is configured together with its source on the interface (never returned for surveys) | |
| grading_threshold | No | threshold of the grading in percentage (only present if a threshold is configured for the exam) | |
| view_results_start | No | start of the results viewing period (only present if view_results is datetime or datetime_blind) | |
| hide_ingame_results | No | the results are hidden while the test is taken | |
| export_custom_fields | No | the user data fields filled in by the examinees are exported (see edubase_get_exam_fields), never returned for surveys | |
| export_finished_only | No | only the examinees who finished their test are exported (never returned for surveys) | |
| view_results_identifier | No | label of the custom user data field the examinees can look up their results with (only present if view_results is datetime or datetime_blind) |