Get Quiz

Responses
🟢200OK
application/vnd.api+json
Success
Body
data
object (Quiz)
required
string
required
The primary key for each resource.
Example:
FID001
type
enum<string>
required
Identifies the Resource.
Allowed value:
Quiz
Example:
Quiz
attributes
object
optional
relationships
object
optional
included
array[object (GenericResource) {4}]
optional
string
optional
The primary key for each resource.
Example:
FID001
type
string
optional
Identifies the Resource.
Example:
_User
attributes
object
optional
relationships
object
optional
Example
{
    "data": {
        "id": "FID001",
        "type": "Quiz",
        "attributes": {
            "title": "string",
            "description": "string",
            "shortDescription": "string",
            "totalQuestions": 0,
            "instructionsEnabled": true,
            "instructionsTitle": "string",
            "instructionsBody": "string",
            "instructionsTimerDurationMs": 1,
            "instructionsEnforcedTimer": "afterAudioStarts",
            "instructionsAudioAutoAdvance": "disabled",
            "instructionsAudioAutoAdvanceDelayMs": 0,
            "instructionsAudioAutoPlay": true,
            "instructionsDisableAudioControls": true,
            "markingCreditsPerQuestion": 0,
            "markingPartialCreditsPerQuestion": 0,
            "markingPenaltiesPerQuestion": 0,
            "markingPenaltiesEnabled": true,
            "grades": [
                {
                    "label": "string",
                    "minScore": 0,
                    "isPass": true,
                    "description": "string"
                }
            ],
            "allowedModes": [
                "practice"
            ],
            "allowedLengths": [
                "default"
            ],
            "allowedPlayers": [
                "default"
            ],
            "allowedTagSets": [
                "string"
            ],
            "allowedFacets": [
                "subject"
            ],
            "calculatorEnabled": true,
            "tagSelectionDisplayMode": "dropdown",
            "allowMultipleTagSelection": true,
            "excludeUntaggedQuestions": true,
            "showMasteryFilters": true,
            "calculatorType": "basic",
            "securityDisableCopying": true,
            "securityDisablePasting": true,
            "securityDisableRightClick": true,
            "navigationDisableNavigation": true,
            "navigationDisableControlPanel": true,
            "navigationDisableNotifications": true,
            "softSectionsEnabled": true,
            "shuffleSectionsEnabled": true,
            "shuffleQuestions": "disabled",
            "notepadEnabled": true,
            "strikethroughEnabled": true,
            "highlightingEnabled": true,
            "bookmarkingEnabled": true,
            "micSettingsEnabled": true,
            "labValuesEnabled": true,
            "labValuesHtml": "string",
            "resumeLaterButtonEnabled": true,
            "flaggingEnabled": true,
            "showAvailableMarks": true,
            "playerType": "default",
            "theme": "string",
            "fontSize": "xSmall",
            "pinnedMessageDuringTest": "string",
            "deferResultsEnabled": true,
            "deferResultsMessage": "string",
            "deferResultsAlwaysRelease": true,
            "whenCompleteNoGradesMessage": "string",
            "completedMessage": "string",
            "resultsOverviewWhenPassedMessage": "string",
            "resultsOverviewWhenFailedHasResitsMessage": "string",
            "resultsOverviewWhenFailedNoResitsMessage": "string",
            "resultsOverviewWhenCompleteNoGradesMessage": "string",
            "resultsMessagePassed": "string",
            "resultsMessageFailed": "string",
            "resultsMessageResitsRemaining": "string",
            "resultsMessageNoResitsRemaining": "string",
            "resultsMessageCompleted": "string",
            "resultsMessageSettingHideTitle": true,
            "resultsMetricScoreEnabled": true,
            "resultsMetricTimeSpentEnabled": true,
            "resultsMetricGradeEnabled": true,
            "resultsMetricProgressEnabled": true,
            "resultsMetricQuestionBreakdownDisplayLevel": "full",
            "resultsMetricAnalyticsCohort": "exam",
            "resultsMetricCohortAverageEnabled": true,
            "resultsMetricCohortPercentileEnabled": true,
            "resultsMetricCohortScoreDistributionEnabled": true,
            "resultsMetricTagBreakdownEnabled": true,
            "resultsMetricTagProgressEnabled": true,
            "resultsMetricTagProgressFacetsEnabled": {
                "subject": true,
                "topic": true,
                "subtopic": true,
                "skill": true,
                "difficulty": true
            },
            "resultsEducatorViewAsAdminEnabled": true,
            "timerEnabled": true,
            "timerHidden": true,
            "timerUseQuestions": true,
            "timerUseSections": true,
            "timerEnforceFullTime": true,
            "timerTimeInMs": 1,
            "timerExtraTimeMultiplier": 0,
            "timerSoftTimer": true,
            "mutexLockKey": "string",
            "mutexLockExpiresAt": "string",
            "mutexLockType": "write",
            "certificatesEnabled": true,
            "certificatesTemplateId": "string",
            "certificatesQrCode": true,
            "certificatesTtl": 0,
            "certificatesIgnoreSubPortalBranding": true,
            "certificatesIssueOnFail": true,
            "certificatesResultsPage": true,
            "certificatesSharingImageUrl": "string",
            "resitEnabled": true,
            "resitType": "continuous",
            "resitMode": "standard",
            "resitGradeIndependent": true,
            "resitAllowedAttempts": 0,
            "resitDelay": 0,
            "resitCloseDelay": 0,
            "resitScheduleActivateAt": "string",
            "resitScheduleDeactivateAt": "string",
            "proctorEnabled": true,
            "proctorVendor": "internal",
            "proctorRequireFullscreen": true,
            "proctorRestrictTabs": true,
            "proctorRestrictDisplays": true,
            "proctorRecordSession": true,
            "proctorRecordSnapshots": true,
            "proctorRecordDesktop": true,
            "proctorOnBreach": "freeze",
            "proctorLiveProctoring": true,
            "proctorRosalynRuleUsePrivateTestArea": true,
            "proctorRosalynRuleVisibleFace": true,
            "proctorRosalynRuleDoNotAllowInteractionWithOthers": true,
            "proctorRosalynRuleDoNotAllowOtherMaterials": true,
            "proctorRosalynRuleDoNotAllowNoiseMakingDevices": true,
            "proctorRosalynRuleDoNotAllowAdditionalDevices": true,
            "proctorRosalynRuleAllowMouseKeyboardMonitorOnly": true,
            "proctorRosalynRuleDoNotAllowAppsOrBroswerTabs": true,
            "proctorRosalynRuleDoNotAllowExamContentSharing": true,
            "access": {},
            "legalEnabled": true,
            "legalTitle": "string",
            "legalBody": "string",
            "legalCheckboxLabel": "string",
            "dynamicVariationEnabled": true,
            "dynamicVariationMaxVariants": 0,
            "scheduleOpenDate": "string",
            "scheduleCloseDate": "string",
            "scheduleSubmissionDueDate": "string",
            "scheduleRelativeCloseTimeInMs": 0,
            "dynamicFiltersWeightingType": "absolute",
            "dynamicFilterRules": [
                {}
            ],
            "isDynamic": true,
            "isSectioned": true,
            "version": "string",
            "status": "draft"
        },
        "relationships": {
            "questions": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "QuizQuestion"
                    }
                ]
            },
            "emqGroups": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "QuizEmqGroup"
                    }
                ]
            },
            "sections": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "QuizSection"
                    }
                ]
            },
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            },
            "instructionsAudio": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            },
            "sourceContentQuizzes": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "Quiz"
                    }
                ]
            },
            "sourceSettingsQuiz": {
                "data": {
                    "id": "FID001",
                    "type": "Quiz"
                }
            },
            "tagSet": {
                "data": {
                    "id": "FID001",
                    "type": "TagSet"
                }
            }
        }
    },
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ]
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠422Parameter Error
Request

Request samples

Responses
