edubase_get_exam_settings
Read-onlyIdempotent
Retrieve an exam's settings. For surveys, grading and results viewing settings are not returned.
Instructions
Get the settings of an exam. Surveys are never graded and their results cannot be viewed later, so the grading and the results viewing settings are not returned for them. The columns of the results export cannot be configured for surveys either, only the format and the ordering of the exported file.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| exam | Yes | exam identification string |
Output Schema
TableJSON 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) |