# paths./.get.description
If parent ID is specified, the result will return a list of assessments under this parent. If the parent is not specified, the result will return all accessible assessments.

# paths./.get.parameters[].description
Format - uuid. Parent id, null means get all accessible assessment which has no parent

# paths./.get.responses.403.description
Login user not authorized to perform this action

# paths./.put.responses.403.description
Login user not authorized to perform this action

# paths./.post.description
Create a normal assessment. 
            
            If the parentID/moduleID is specified, only user with the Manager access can create the assessment under the module.
            
            Otherwise only users with “RootResource.Create” role can call this API.

# paths./.post.requestBody.description
The assessment item information with its settings.

# paths./.post.responses.403.description
Login user not authorized to perform this action

# paths./.delete.responses.403.description
Login user not authorized to perform this action.

# paths./.patch.responses.403.description
Login user not authorized to perform this action

# paths./{ParentID}/search.get.description
Search assessments which are under a parent/module

# paths./{ParentID}/search.get.responses.403.description
Login user not authorized to perform this action

# paths./{id}.get.responses.403.description
Login user not authorized to perform this action

# paths./{id}.delete.responses.403.description
Login user not authorized to perform this action.

# paths./{id}/poster.get.description
Get poster for video file in in-video assessment.This poster will be displayed in the video placeholder before user playing the video.

# paths./{id}/poster.get.responses.200.description
The file stream with content type application/octet-stream

# paths./{id}/question_analysis.get.description
Get question analysis result for normal assessment

# paths./{id}/question_analysis.get.parameters[].description
C: All Completed Attempt (default)/ F: First Marked Attempt/ L: Last Marked Attempt/ B: Best Marked Attempt

# paths./{id}/student_analysis.get.description
Get student analysis result for normal assessment

# paths./{id}/student_analysis.get.parameters[].description
F: First Marked Attempt/ L: Last Marked Attempt/ B: Best Marked Attempt (default)

# paths./{id}/invideo_student_analysis.get.description
Get student analysis result for in-video assessment

# paths./{id}/invideo_question_analysis.get.description
Get question analysis result for in-video assessment

# paths./{id}/copy/{DestId}.post.description
Duplicate an assessment within current module or to another module.

# paths./{id}/copy/{DestId}.post.parameters[].description
Format - uuid. New destination id, could be another module or current module

# paths./{id}/copy/{DestId}.post.responses.403.description
Login user not authorized to perform this action

# paths./{id}/copy/{DestId}.post.responses.404.description
Specified assessment or destination is not found

# paths./video/upload.put.responses.403.description
Login user not authorized to perform this action

# paths./video/import.put.description
Import multimedia stream video into in-video assessment

# paths./video/import.put.requestBody.description
ID of the multimedia video and ID of the in-video assessment

# paths./video/import.put.responses.403.description
Login user not authorized to perform this action

# paths./video/import.put.responses.404.description
Specified assessment or the multimedia video is not found

# paths./exportToGradebook.post.description
Export marks located on one or multiple assessment into one gradebook item

# paths./exportToGradebook.post.responses.403.description
Login user not authorized to perform this action

# paths./{moduleID}/exportToGradebook.get.description
Get list of normal assessments under a module which have valid marks to be exported to gradebook.

# paths./{moduleID}/exportToGradebook.get.responses.200.description
List of assessments which are available for export

# paths./{moduleID}/exportToGradebook.get.responses.403.description
Login user not authorized to perform this action

# paths./excel.post.description
Export sessions and/or student reponses(raw data) into excel.

# paths./excel.post.responses.403.description
Login user not authorized to perform this action.

# paths./{id}/Question.get.description
Get questions under an assessment or under a section in a normal assessment

# paths./{id}/Question.get.parameters[].description
Format - uuid. Section id if get the question for that section only

# paths./{id}/Question.get.parameters[].description
Format - uuid. only populate responses for a specific student, used by module facilicators

# paths./{id}/Question.get.responses.403.description
Login user not authorized to perform this action.

# paths./{id}/Question/search.get.responses.403.description
Login user not authorized to perform this action

# paths./{assessmentid}/Question/{id}.get.responses.403.description
Login user not authorized to perform this action

# paths./{assessmentid}/Question/{id}.get.responses.404.description
The Assessment is not found or The question is not found

# paths./session/{id}/question.get.description
Get list of questions displayed for a specific student session of a normal assessment.

# paths./session/{id}/question.get.parameters[].description
Format - uuid. Section id if get the question for that section only

# paths./session/{id}/question.get.parameters[].description
Accepted populate entities:response (student's responses on the questions), responseWithFeedback (lecturer configured feedback contents for completed session),responseWithMarkAndSectionName (used by Lecturer), tags

# paths./session/{id}/question.get.responses.403.description
Login user not authorized to perform this action.

# paths./Question/TOF.put.requestBody.description
True/False question input. ID is required

# paths./Question/TOF.put.responses.403.description
Login user not authorized to perform this action.

# paths./Question/TOF.post.requestBody.description
True/False question input. ResourceID is assessment id, parent id is section Id(if any)

# paths./Question/TOF.post.responses.403.description
Login user not authorized to perform this action

# paths./Question/TOF.patch.requestBody.description
True/False question input. ID is required

# paths./Question/TOF.patch.responses.403.description
Login user not authorized to perform this action.

# paths./Question/Choice.put.responses.403.description
Login user not authorized to perform this action.

# paths./Question/Choice.post.requestBody.description
Choices question input. ResourceID is assessment id, parent id is section Id(if any)

# paths./Question/Choice.post.responses.403.description
Login user not authorized to perform this action

# paths./Question/Choice.patch.responses.403.description
Login user not authorized to perform this action.

# paths./Question/Essay.put.responses.403.description
Login user not authorized to perform this action.

# paths./Question/Essay.post.requestBody.description
Essay question input. ResourceID is assessment id, parent id is section Id(if any)

# paths./Question/Essay.post.responses.403.description
Login user not authorized to perform this action

# paths./Question/Essay.patch.responses.403.description
Login user not authorized to perform this action.

# paths./Question/FIB.put.requestBody.description
Fill-in-the-blank question input. ID is required

# paths./Question/FIB.put.responses.403.description
Login user not authorized to perform this action.

# paths./Question/FIB.post.requestBody.description
Fill-in-the-blank question input. ResourceID is assessment id, parent id is section Id(if any)

# paths./Question/FIB.post.responses.403.description
Login user not authorized to perform this action

# paths./Question/FIB.patch.requestBody.description
Fill-in-the-blank question input. ID is required

# paths./Question/FIB.patch.responses.403.description
Login user not authorized to perform this action.

# paths./Question/Matching.put.responses.403.description
Login user not authorized to perform this action.

# paths./Question/Matching.post.requestBody.description
matching question input. ResourceID is required

# paths./Question/Matching.post.responses.403.description
Login user not authorized to perform this action

# paths./Question/Matching.patch.responses.403.description
Login user not authorized to perform this action.

# paths./Question/Sort.put.description
Sort questions in a section or in a normal assessment or in the same timeline of in-video assessment

# paths./Question/Sort.put.requestBody.description
List of question ids in the newly sorted order

# paths./Question/Sort.put.responses.403.description
Login user not authorized to perform this action.

# paths./Question/MarkingScheme.put.description
Update marks and negetive marks of questions in an assessment, Calling this function will re-mark existing student attempts.

# paths./Question/MarkingScheme.put.responses.403.description
Login user not authorized to perform this action.

# paths./Question/TimeStamp.put.description
Update time stamp of questions in an in-video assessment.

# paths./Question/TimeStamp.put.responses.403.description
Login user not authorized to perform this action.

# paths./Question/{ID}.delete.description
Delete a question from an assessment. Responses, marks and comments made on this question will be deleted as well.

# paths./Question/{ID}.delete.responses.403.description
Login user not authorized to perform this action.

# paths./Question.delete.description
Delete list of questions from assessment. Responses, marks and comments made on these questions will be deleted as well.

# paths./Question.delete.responses.403.description
Login user not authorized to perform this action.

# paths./{ID}/Question.delete.description
Delete all questions in an assessment. Sessions, Responses, marks and comments made on these questions will be deleted as well.

# paths./{ID}/Question.delete.responses.403.description
Login user not authorized to perform this action.

# paths./session/{id}/response.get.description
Get all responses within a session in a normal assessment

# paths./session/{id}/response.get.responses.403.description
Login user not authorized to perform this action.

# paths./session/{id}/response.post.description
Save individual repsonse made on a question in a specific session

# paths./session/{id}/response.post.responses.403.description
Login user not authorized to perform this action.

# paths./session/{id}/response.post.responses.404.description
Specified session or question is not found.

# paths./session/{id}/response.put.description
Save individual repsonse made on a question in a specific completed session, used by lecturer who overwrite response for a student

# paths./session/{id}/response.put.responses.403.description
Login user not authorized to perform this action.

# paths./session/{id}/response.put.responses.404.description
Specified session or question is not found.

# paths./{id}/response.get.description
Get all student responses made in an assessment

# paths./{id}/response.get.parameters[].description
F: First Completed Attempt/B:Best Completed Attempt (for normal assessment) / L: Last Completed Attempt/ C: All Completed Attempt / not specified : All Attempt

# paths./{id}/response.get.responses.403.description
Login user not authorized to perform this action.

# paths./{id}/response.delete.description
For lecturer to delete all responses made by ALL students for in-video assessment.

# paths./{id}/response.delete.responses.403.description
Login user not authorized to perform this action.

# paths./response/{id}.get.responses.403.description
Login user not authorized to perform this action.

# paths./session/{id}/question/{questionId}/response.get.description
Get login user's latest response made on a question

# paths./session/{id}/question/{questionId}/response.get.responses.403.description
Login user not authorized to perform this action.

# paths./session/{id}/question/{questionId}/response.get.responses.404.description
Specified response is not found. User has not answered this question.

# paths./session/{id}/responses.post.description
Save repsonses made on multiple questions in a specific session

# paths./session/{id}/responses.post.responses.403.description
Login user not authorized to perform this action.

# paths./session/{id}/responses.post.responses.404.description
Specified session or question is not found.

# paths./response.post.description
Save individual repsonse made on a question in an in-video assessment

# paths./response.post.responses.403.description
Login user not authorized to perform this action.

# paths./mark.post.description
Adjust marks manually and make comments for a student answer on a specific question in a normal assessment

# paths./mark.post.responses.403.description
Login user not authorized to perform this action.

# paths./mark.post.responses.201.description
Updated response with marks and comments

# paths./{id}/response/{studentId}.delete.description
For lecturer to delete all responses made by a student for in-video assessment.

# paths./{id}/response/{studentId}.delete.responses.403.description
Login user not authorized to perform this action.

# paths./{id}/section.get.responses.403.description
Login user not authorized to perform this action

# paths./section/{id}.get.responses.403.description
Login user not authorized to perform this action

# paths./Section.put.responses.403.description
Login user not authorized to perform this action

# paths./Section.post.responses.403.description
Login user not authorized to perform this action

# paths./Section/Sort.put.requestBody.description
List of section ids in newly sorted order

# paths./Section/Sort.put.responses.403.description
Login user not authorized to perform this action.

# paths./Section/{id}.delete.responses.403.description
Login user not authorized to perform this action.

# paths./{id}/session.get.description
Get sessions within a normal assessment.

# paths./{id}/session.get.parameters[].description
attempt type, applies for normal assessment A: All Attempt (default) / C: All Completed Attempt/ F: First Marked Attempt/ L: Last Marked Attempt/ B: Best Marked Attempt/I:All Incompleted Attempt/U: Completed Attempt with unmarked questions

# paths./{id}/session.get.responses.200.description
List of student sessions for this assessment

# paths./{id}/session.get.responses.403.description
Login user not authorized to perform this action

# paths./session/{id}.get.description
Get a single sessions within a normal assessment. Only lecturer of the assessment or the student who did the session can get the information.

# paths./session/{id}.get.responses.403.description
Login user not authorized to perform this action.

# paths./{id}/ownsession.get.description
Get user's own sessions within an normal assessment

# paths./session/{id}/exit.put.description
Exit a session to resume later, used when student closing browser window when taking assessment

# paths./session/{id}/exit.put.parameters[].description
Format - int32. count down timer for logging

# paths./session/{id}/exit.put.responses.403.description
Login user not authorized to perform this action.

# paths./session/{id}/submit.put.description
Submit session, used when student submit/finish taking the assessment. It can also be used by lecturer when student forgot to submit his/her session. A submitted session is considered as 'Completed'.

# paths./session/{id}/submit.put.parameters[].description
Format - int32. count down timer for logging

# paths./session/{id}/submit.put.parameters[].description
whether user click the submit button to submit

# paths./session/{id}/submit.put.responses.403.description
Login user not authorized to perform this action.

# paths./{id}/session/submit.put.description
Submit all incomplete session, used by lecturer after the assessment is closed/expired. A submitted session is considered as 'Completed'.

# paths./{id}/session/submit.put.responses.403.description
Login user not authorized to perform this action.

# paths./session/mark.post.description
Adjust overall score generated by system and/or make an overall comment for a student session.

# paths./session/mark.post.responses.403.description
Login user not authorized to perform this action.

# paths./{id}/session/remark.post.description
After lecturer changed questions, marking scheme or rubric information, this api can be used to re-caculate system-generaled marks for all student sessions which submitted before the change.

# paths./{id}/session/remark.post.responses.200.description
List of student sessions for this assessment

# paths./{id}/session/remark.post.responses.403.description
Login user not authorized to perform this action

# paths./Session/{id}.delete.responses.403.description
Login user not authorized to perform this action.

# paths./Session.delete.description
Delete selected sessions in a normal assessment

# paths./Session.delete.responses.403.description
Login user not authorized to perform this action.

# paths./{id}/Session.delete.description
Delete all sessions in a normal assessment

# paths./{id}/Session.delete.responses.403.description
Login user not authorized to perform this action.

# paths./Session/{id}/email.post.description
Email completed session summary to student

# paths./Session/{id}/email.post.responses.403.description
Login user not authorized to perform this action.

# paths./question/{id}/response.get.parameters[].description
true means only the respones with in submitted/completed sessions will be returned, applies to normal assessment

# paths./question/{id}/response.get.parameters[].description
F: First Completed Attempt/ L: Last Completed Attempt/ C: All Completed Attempt (default). Used when CompleteOnly is true or when the video is an in-video assessment

# paths./question/{id}/response.get.responses.403.description
Login user not authorized to perform this action.

# paths./sort.put.requestBody.description
List of assessment ids in newly sorted order

# paths./sort.put.responses.403.description
Login user not authorized to perform this action.

# paths./{id}/question_analysis_excel.get.description
Get question analysis result for assessment

# paths./{id}/question_analysis_excel.get.parameters[].description
attempt type, applies for normal assessment C: All Completed Attempt (default)/ F: First Marked Attempt/ L: Last Marked Attempt/ B: Best Marked Attempt

# paths./multiple/excel.post.summary
Export marks from multiple assessments into excel

# paths./multiple/excel.post.description
Export marks located on one or multiple assessment into one gradebook item

# paths./multiple/excel.post.requestBody.description
Settings to export toExcel to gradebook form

# paths./multiple/excel.post.responses.403.description
Login user not authorized to perform this action

# paths./{id}/session/search.get.description
Get all searched sessions within a normal assessment.

# paths./{id}/session/search.get.parameters[].description
attempt type, applies for normal assessment A: All Attempt (default) / C: All Completed Attempt/ F: First Marked Attempt/ L: Last Marked Attempt/ B: Best Marked Attempt/I:All Incompleted Attempt/U: Completed Attempt with unmarked questions

# paths./{id}/session/search.get.parameters[].description
text to seach student attempt. Minimum 3 characters

# paths./{id}/session/search.get.responses.200.description
List of searched student sessions for this assessment

# paths./{id}/session/search.get.responses.403.description
Login user not authorized to perform this action

# paths./timeExtension/{id}.get.summary
get extension settings for a specific assessment

# paths./timeExtension/{id}.get.description
get extension settings for a specific assessment

# paths./timeExtension.post.summary
set the time extension for a speific student

# paths./timeExtension.post.description
set the time extension for a speific student

# paths./timeExtension/{id}/{studentid}.delete.summary
delete extension setting for a specific user.

# paths./timeExtension/{id}/{studentid}.delete.description
delete extension setting for a specific user.

# paths./mark/multiple.post.description
Adjust marks manually and make comments for multiple student answers in a normal assessment

# paths./mark/multiple.post.responses.403.description
Login user not authorized to perform this action.

# paths./mark/multiple.post.responses.201.description
Updated responses with marks and comments

# paths./SyncToGradebook/{gbId}.put.summary
Sync Marks from Assessment(s) to Gradebook

# paths./SyncToGradebook/{gbId}.put.description
Update marks in gradebook item which was imported from assessment previously

# paths./SyncToGradebook/{gbId}.put.responses.403.description
Login user not authorized to perform this action

# paths./session/start.post.description
Start a new session or resume an incompleted session, used when student start taking a normal assessment

# paths./session/start.post.responses.403.description
Login user not authorized to perform this action.

# paths./Session/{id}/procApplog.post.summary
log the incident that the ProctprTrack App is not working

# paths./Session/{id}/procApplog.post.description
log the incident that the ProctprTrack App is not working. Used for ProctorTrack

# paths./Session/{id}/procApplog.post.responses.403.description
Login user not authorized to perform this action.

# paths./{id}/progress.get.description
Get all students with completion status for this assessment.

# paths./{id}/progress.get.responses.200.description
List of student sessions for this assessment

# paths./{id}/progress.get.responses.403.description
Login user not authorized to perform this action

# paths./exam.post.requestBody.description
The assessment item information with its settings.

# paths./exam.post.responses.403.description
Login user not authorized to perform this action

# paths./{id}/getadaptivedataset.get.description
Get mapping dataset based on assessmentID and Student

# paths./{id}/getadaptivedataset.get.responses.403.description
Login user not authorized to perform this action

# paths./{id}/addadaptivedataset.post.summary
Add mapping dataset for adaptive assessment

# paths./{id}/addadaptivedataset.post.description
Creates a mapping dataset for adaptive assessment

# paths./{id}/addadaptivedataset.post.parameters[].description
Format - uuid. The mapping dataset item information

# paths./{id}/addadaptivedataset.post.responses.403.description
Login user not authorized to perform this action

# paths./{id}/deleteadaptivedataset.delete.summary
Delete mapping dataset for adaptive assessment

# paths./{id}/deleteadaptivedataset.delete.description
Deletes a mapping dataset for adaptive assessment

# paths./{id}/deleteadaptivedataset.delete.parameters[].description
Format - uuid. The mapping dataset item information to be deleted

# paths./{id}/deleteadaptivedataset.delete.requestBody.description
The mapping dataset item information to be deleted

# paths./{id}/deleteadaptivedataset.delete.responses.403.description
Login user not authorized to perform this action

# paths./test.post.responses.403.description
Login user not authorized to perform this action

# components.schemas.contract.ACL.Models.Access_Result.properties.access_Full.description
all accesses on the resource and its contents

# components.schemas.contract.ACL.Models.Access_Result.properties.access_Settings_Read.description
read-only access on the resource setting

# components.schemas.API_Assessment.API.QuizFeedbackContent.description
type of contents which lecturer decide to show after student completed the assessment

# components.schemas.API_Assessment.API.Assessment.properties.parentId.description
the parent entity of the assessment, usually the module. if it is same as ID, means it has no parent.

# components.schemas.API_Assessment.API.Assessment.properties.creatorID.description
ID of the user who created this assessment

# components.schemas.API_Assessment.API.Assessment.properties.lastUpdatedBy.description
ID of the user who lastly updated the assessment

# components.schemas.API_Assessment.API.Assessment.properties.creatorName.description
the name of the user who created the assessment

# components.schemas.API_Assessment.API.Assessment.properties.updatorName.description
the name of the user who lastly updated the assessment

# components.schemas.API_Assessment.API.Assessment.properties.isOpen.description
whether the assessment is open to student

# components.schemas.API_Assessment.API.Assessment.properties.assessmentType.description
Assessment type: 0 - normal assessment, 1 - in-video assessment

# components.schemas.API_Assessment.API.Assessment.properties.hasPassword.description
whether this normal assessment is password protected

# components.schemas.API_Assessment.API.Assessment.properties.fileName.description
video file name for a in-video assessment

# components.schemas.API_Assessment.API.Assessment.properties.fileSize.description
video file size for a in-video assessment

# components.schemas.API_Assessment.API.Assessment.properties.streamUrl.description
video stream url for a in-video assessment

# components.schemas.API_Assessment.API.Assessment.properties.description.description
instructional text for students before they taking the assessment

# components.schemas.API_Assessment.API.Assessment.properties.password.description
password required to take the assessment, if specified, used for normal assessemnt only

# components.schemas.API_Assessment.API.Assessment.properties.attemptLimit.description
maximum number of sessions student can have.0 means unlimited attempt

# components.schemas.API_Assessment.API.Assessment.properties.timeLimit.description
time limit in minutes, 0 means no time limit, used for normal assessemnt only

# components.schemas.API_Assessment.API.Assessment.properties.resumeType.description
resume type for quiz with time-limit, used for normal assessemnt only

0 - resume with continuous timer

1 - resume with stop timer

# components.schemas.API_Assessment.API.Assessment.properties.displayType.description
content display type, used for normal assessemnt only
0 - display all content in one page

1 - display section per page

2- display a question per page

3- display section per page, student cannot navigate to previous section

4 - display a question per page, student cannot navigate to previous question

# components.schemas.API_Assessment.API.Assessment.properties.feedbackContents.description
contents which lecturer decide to show after student completed the assessment, used for normal assessemnt only

0 - responses made by students in each question
 
1 - correct answer for each question

2 - feedback which user entered when creating question

3 - lecturer comments on a student's response for a question, as well as the overal comments for the student's session

4 - score obtained for a question

5 - total score and overall comment obtained for the session

6 - feedback for student selected options.

# components.schemas.API_Assessment.API.Assessment.properties.viewFeedbackFromDate.description
The time when student can view feedback since. If not specified, means student can always view feedback after submission, used for normal assessemnt only

# components.schemas.API_Assessment.API.Assessment.properties.viewFeedbackToDate.description
The time when student can view feedback until. If not specified, means student can always view feedback after submission, used for normal assessemnt only

# components.schemas.API_Assessment.API.Assessment.properties.passingMark.description
indicate a passing mark for normal assessment.

It can be set if there are questions inside the assesment and there is no complete student attempts. 

It cannot be used if there are Essay questions inside the assessment.

# components.schemas.API_Assessment.API.Assessment.properties.is2FaEnabled.description
whether user need 2FA security when navigating into staff pages of this quiz

# components.schemas.API_Assessment.API.Assessment.properties.randomizeSections.description
indicate whether the sections are displayed in randomized order when students taking the assessment.

# components.schemas.API_Assessment.API.Assessment.properties.backgroundColor.description
The html color code which defines the background color of the webpage when student taking the normal quiz (if any). The color has to be light color.

# components.schemas.contract.ACL.Models.InputRoleAccess.properties.groupAccess.description
Group access rights defined for this resource

# components.schemas.contract.ACL.Models.InputRoleAccess.properties.userAccess.description
Individual user access rights which is different from the groups the user belongs to (if any)

# components.schemas.contract.ACL.Models.InputRoleAccess.properties.publicAccess.description
the access rights which the user defined for public. null means NO_ACCESS

# components.schemas.contract.ACL.Models.InputRoleAccess.properties.inheritedResourceID.description
not null means it follow permission from another resource

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.parentId.description
parent id of the assessment, null means no parent

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.access.description
all access rights defined for the assessment

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.lessonID.description
lesson Id if it is created as a lesson activity

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.description.description
instructional text for students before they taking the assessment

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.password.description
password required to take the assessment, if specified, used for normal assessemnt only

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.attemptLimit.description
maximum number of sessions student can have.0 means unlimited attempt

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.timeLimit.description
time limit in minutes, 0 means no time limit, used for normal assessemnt only

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.resumeType.description
resume type for quiz with time-limit, used for normal assessemnt only

0 - resume with continuous timer

1 - resume with stop timer

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.displayType.description
content display type, used for normal assessemnt only
0 - display all content in one page

1 - display section per page

2- display a question per page

3- display section per page, student cannot navigate to previous section

4 - display a question per page, student cannot navigate to previous question

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.feedbackContents.description
contents which lecturer decide to show after student completed the assessment, used for normal assessemnt only

0 - responses made by students in each question
 
1 - correct answer for each question

2 - feedback which user entered when creating question

3 - lecturer comments on a student's response for a question, as well as the overal comments for the student's session

4 - score obtained for a question

5 - total score and overall comment obtained for the session

6 - feedback for student selected options.

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.viewFeedbackFromDate.description
The time when student can view feedback since. If not specified, means student can always view feedback after submission, used for normal assessemnt only

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.viewFeedbackToDate.description
The time when student can view feedback until. If not specified, means student can always view feedback after submission, used for normal assessemnt only

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.passingMark.description
indicate a passing mark for normal assessment.

It can be set if there are questions inside the assesment and there is no complete student attempts. 

It cannot be used if there are Essay questions inside the assessment.

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.is2FaEnabled.description
whether user need 2FA security when navigating into staff pages of this quiz

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.randomizeSections.description
indicate whether the sections are displayed in randomized order when students taking the assessment.

# components.schemas.API_Assessment.API.InputAssessmentForCreate.properties.backgroundColor.description
The html color code which defines the background color of the webpage when student taking the normal quiz (if any). The color has to be light color.

# components.schemas.API_Assessment.API.InputAssessmentForCreate.description
data used when creating a normal assessment

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.access.description
all access rights defined for the assessment

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.description.description
instructional text for students before they taking the assessment

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.password.description
password required to take the assessment, if specified, used for normal assessemnt only

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.attemptLimit.description
maximum number of sessions student can have.0 means unlimited attempt

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.timeLimit.description
time limit in minutes, 0 means no time limit, used for normal assessemnt only

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.resumeType.description
resume type for quiz with time-limit, used for normal assessemnt only

0 - resume with continuous timer

1 - resume with stop timer

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.displayType.description
content display type, used for normal assessemnt only
0 - display all content in one page

1 - display section per page

2- display a question per page

3- display section per page, student cannot navigate to previous section

4 - display a question per page, student cannot navigate to previous question

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.feedbackContents.description
contents which lecturer decide to show after student completed the assessment, used for normal assessemnt only

0 - responses made by students in each question
 
1 - correct answer for each question

2 - feedback which user entered when creating question

3 - lecturer comments on a student's response for a question, as well as the overal comments for the student's session

4 - score obtained for a question

5 - total score and overall comment obtained for the session

6 - feedback for student selected options.

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.viewFeedbackFromDate.description
The time when student can view feedback since. If not specified, means student can always view feedback after submission, used for normal assessemnt only

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.viewFeedbackToDate.description
The time when student can view feedback until. If not specified, means student can always view feedback after submission, used for normal assessemnt only

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.passingMark.description
indicate a passing mark for normal assessment.

It can be set if there are questions inside the assesment and there is no complete student attempts. 

It cannot be used if there are Essay questions inside the assessment.

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.is2FaEnabled.description
whether user need 2FA security when navigating into staff pages of this quiz

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.randomizeSections.description
indicate whether the sections are displayed in randomized order when students taking the assessment.

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.properties.backgroundColor.description
The html color code which defines the background color of the webpage when student taking the normal quiz (if any). The color has to be light color.

# components.schemas.API_Assessment.API.InputAssessmentForUpdate.description
input data when modifying the assessment

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.access.description
all access rights defined for the assessment

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.description.description
instructional text for students before they taking the assessment

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.password.description
password required to take the assessment, if specified, used for normal assessemnt only

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.attemptLimit.description
maximum number of sessions student can have.0 means unlimited attempt

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.timeLimit.description
time limit in minutes, 0 means no time limit, used for normal assessemnt only

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.resumeType.description
resume type for quiz with time-limit, used for normal assessemnt only

0 - resume with continuous timer

1 - resume with stop timer

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.displayType.description
content display type, used for normal assessemnt only
0 - display all content in one page

1 - display section per page

2- display a question per page

3- display section per page, student cannot navigate to previous section

4 - display a question per page, student cannot navigate to previous question

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.feedbackContents.description
contents which lecturer decide to show after student completed the assessment, used for normal assessemnt only

0 - responses made by students in each question
 
1 - correct answer for each question

2 general comments user entered when creating question

3- lecturer comments on a student's response for a question, as well as the overal comments for the student's session

4 - score obtained for a question

5 - total score and overall comment obtained for the session

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.viewFeedbackFromDate.description
The time when student can view feedback since. If not specified, means student can always view feedback after submission, used for normal assessemnt only

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.viewFeedbackToDate.description
The time when student can view feedback until. If not specified, means student can always view feedback after submission, used for normal assessemnt only

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.passingMark.description
indicate a passing mark for normal assessment.

It can be set if there are questions inside the assesment and there is no complete student attempts. 

It cannot be used if there are Essay questions inside the assessment.

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.quizType.description
assessment type. can be changed from normal assessment to exam type or from exam type to normal assessment

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.randomizeSections.description
indicate whether the sections are displayed in randomized order when students taking the assessment.

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.is2FaEnabled.description
whether user need 2FA security when navigating into staff pages of this quiz

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.properties.backgroundColor.description
The html color code which defines the background color of the webpage when student taking the normal quiz (if any). The color has to be light color.

# components.schemas.API_Assessment.API.InputAssessmentForUpdatePartial.description
input data when modifying the assessment

# components.schemas.API_Assessment.API.AdaptiveAssessment.description
mapping dataset for the AdaptiveAssessment student session

# components.schemas.API_Assessment.API.InputAssessmentWithExamSetupForCreate.properties.parentId.description
parent id of the assessment, usually the module id

# components.schemas.API_Assessment.API.InputAssessmentWithExamSetupForCreate.properties.lessonID.description
lesson Id if it is created as a lesson activity

# components.schemas.API_Assessment.API.InputAssessmentWithExamSetupForCreate.properties.timeLimit.description
exam duration in minutes, which is the time limit

# components.schemas.API_Assessment.API.InputAssessmentWithExamSetupForCreate.description
data used when creating an assessment with exam setup

# components.schemas.API_Assessment.API.InputAdaptiveAssessment.description
input mapping dataset for the AdaptiveAssessment student session

# components.schemas.API_Assessment.API.InputAdaptiveAssessmentForDeletion.description
input mapping dataset for the AdaptiveAssessment student session

# components.schemas.API_Assessment.API.MultipleExportSetting.properties.importType.description
Import type for the imported tool (Assessment/Quiz or Files). L = Student's Last Marked Attempt; F = Student's First Marked Attempt; B = Student's Best Marked Attempt

# components.schemas.API_Assessment.API.MultipleExportSetting.description
settings used to export multiple assessment marks into excel

# components.schemas.API_Assessment.API.ExportLayout.description
export layout

1. export all records in one excel sheet, one user per row

2. export all records into one excel worksheet, one question per row

3. split all records into multiple excel worksheet, one user per worksheet

3. split all records into multiple excel worksheet, one question per worksheet

# components.schemas.API_Assessment.API.ExportSetting.properties.exportType.description
list of sessions to be exported

A: All Attempts/ C: All Completed Attempt/ F: First Marked Attempt/ L: Last Marked Attempt/ B: Best Marked Attempt for normal quiz

A: All Attempts/ F: First Attempt/ L: Last Attempt for in-video quiz

# components.schemas.API_Assessment.API.ExportSetting.properties.groupID.description
if set, system will export sessions of students which only belongs to this group. it not set, system will export sessions for all students

# components.schemas.API_Assessment.API.ExportSetting.properties.includeUserGroup.description
below field is true means user group information is added to the excel

# components.schemas.API_Assessment.API.ExportSetting.properties.includeUserFaculty.description
below field is true means user faculty/department information is added to the excel

# components.schemas.API_Assessment.API.ExportSetting.properties.includeQuestionsAndResponses.description
below field is true means question text, student answer and student scores in each question is added to the excel

# components.schemas.API_Assessment.API.ExportSetting.properties.sortBy.description
the default sort order of the information, possible value :Name, UserID, Number, StartDate

# components.schemas.API_Assessment.API.ExportSetting.properties.optionAbbreviation.description
whether exported content will use alphabet abbreviation (A,B,C,D..) or number abbreviation (1,2,3,4) to replace the option text in selection questions. Default is no abbreviation, used when IncludeQuestionsAndResponses is enabled. Possible Values:[empty string], Alphabet, Number

# components.schemas.API_Assessment.API.ExportSetting.properties.layout.description
export layout applies when IncludeQuestionsAndResponses is true

1. export all records in one excel sheet, one user per row

2. export all records into one excel worksheet, one question per row

3. split all records into multiple excel worksheet, one user per worksheet

3. split all records into multiple excel worksheet, one question per worksheet

# components.schemas.API_Assessment.API.ExportSetting.properties.startDate.description
The date filter of the session result, if set, only sessions started in normal quiz after this date will be returned. 
For in-video quiz, only responses made after this date will be returned.

# components.schemas.API_Assessment.API.ExportSetting.properties.endDate.description
The date filter of the session result, if set, only sessions started in normal quiz before this date will be returned.
For in-video quiz, only responses made before this date will be returned.

# components.schemas.API_Assessment.API.ExportSetting.description
export settings
the default list of information to be exported to excel will be :

user login id, 

student number, 

student name, 

total score obtained, 

duration of the attempts(if any), 

time when student start this attempt,

time when student submit the answers (if any)

This input defines additional information which to be exported into excel.

# components.schemas.API_Assessment.API.ChoiceOptionAnalysis.properties.noOfStudents.description
number of sessions which has this option selected

# components.schemas.API_Assessment.API.ChoiceOptionAnalysis.properties.selectionRate.description
percentage of session which has this option selected

# components.schemas.API_Assessment.API.ChoiceOptionAnalysis.properties.averageExamScore.description
average score of sessions which has this option selected

# components.schemas.API_Assessment.API.ChoiceOptionAnalysis.description
detailed analysis for question options used for choice selection questions

# components.schemas.API_Assessment.API.OptionAnalysis.properties.noOfCorrectAnswers.description
number of sessions which has this option/blank answered correctly

# components.schemas.API_Assessment.API.OptionAnalysis.properties.noOfIncorrectAnswers.description
number of sessions which has this option/blank answered wrongly

# components.schemas.API_Assessment.API.OptionAnalysis.properties.correctionRate.description
percentage of sessions who has this option/blank answered correctly

# components.schemas.API_Assessment.API.OptionAnalysis.description
detailed analysis for question options used for Fill-in-the-blank question and matching question

# components.schemas.API_Assessment.API.QuestionAnalysis.properties.averageScore.description
average score obtained for this question

# components.schemas.API_Assessment.API.QuestionAnalysis.properties.standardDev.description
standard deviation on all scores in this question

# components.schemas.API_Assessment.API.QuestionAnalysis.properties.percentile25.description
the marks for the 25th percentile threshold obtained from the question

# components.schemas.API_Assessment.API.QuestionAnalysis.properties.percentile75.description
the marks for the 75th percentile threshold obtained from the question

# components.schemas.API_Assessment.API.QuestionAnalysis.properties.noOfCorrectAnswers.description
number of sessions which has this question answered correctly (has score > 0)

# components.schemas.API_Assessment.API.QuestionAnalysis.properties.noOfIncorrectAnswers.description
number of sessions which has skipped this question or answered this question wrongly (has score <=0)

# components.schemas.API_Assessment.API.QuestionAnalysis.properties.correctionRate.description
percentage of sessions who has this question answered correctly

# components.schemas.API_Assessment.API.QuestionAnalysis.properties.choiceOptions.description
detailed analysis for options used for choice selection questions

# components.schemas.API_Assessment.API.QuestionAnalysis.properties.options.description
detailed analysis for question options used for Fill-in-the-blank question and matching question

# components.schemas.API_Assessment.API.QuestionAnalysis.properties.unmarkedQuestions.description
number of questions which have not been marked. Used for Essay Question

# components.schemas.API_Assessment.API.ClassAnalysis.properties.standardDev.description
standard deviation on all scores in class

# components.schemas.API_Assessment.API.ClassAnalysis.properties.kR20.description
The value range is from 0 to 1, where 0 is no reliability and 1 is perfect reliability.  The closer the score is to 1, the more reliable the test. Just what constitites an “acceptable” KR-20 score depends on the type of test. In general, a score of above .5 is usually considered reasonable.
This statistics is valid when there is no partial correct answers in this test.

# components.schemas.API_Assessment.API.StudentSummary.properties.incorrectEasyQuestion.description
number of questions whose score obtained is below class average

# components.schemas.API_Assessment.API.StudentAnalysis.properties.average.description
The average marks obtained from the sessions

# components.schemas.API_Assessment.API.StudentAnalysis.properties.median.description
The median mark obtained from the sessions

# components.schemas.API_Assessment.API.StudentAnalysis.properties.percentile25.description
the marks for the 25th percentile threshold obtained from the sessions

# components.schemas.API_Assessment.API.StudentAnalysis.properties.percentile75.description
the marks for the 75th percentile threshold obtained from the sessions

# components.schemas.API_Assessment.API.StudentAnalysis.properties.sleepStudents.description
list of students who did not finish the assessments

# components.schemas.API_Assessment.API.StudentAnalysis.description
overal analysis for students in normal assessment

# components.schemas.API_Assessment.API.InVideoStudentAnalysis.properties.attempts.description
total number of attempts user used to answer the questions

# components.schemas.API_Assessment.API.InVideoStudentAnalysis.properties.skippedQuestion.description
number of questions which user did not try to answer

# components.schemas.API_Assessment.API.InVideoStudentAnalysis.properties.correctQuestion.description
number of questions which user tried and get it correct at last

# components.schemas.API_Assessment.API.InVideoStudentAnalysis.properties.incorrectQuestion.description
number of questions which user tried but did not get it correct for all attempts

# components.schemas.API_Assessment.API.InVideoStudentAnalysis.description
student analysis for in-video assessment

# components.schemas.API_Assessment.API.InVideoQuestionAnalysisDetail.properties.totalStudents.description
total number of students who tried this question

# components.schemas.API_Assessment.API.InVideoQuestionAnalysisDetail.properties.studentsAttempteOnce.description
total number of students who get this question correct at the first attempt

# components.schemas.API_Assessment.API.InVideoQuestionAnalysisDetail.properties.studentsAttemptedMoreThanOnce.description
total number of students who did not get this question correct at the first attempt

# components.schemas.API_Assessment.API.InVideoQuestionAnalysisDetail.properties.attemptedMoreThanOnce.description
total difficulty of this question. Higher value means more students did not get the question correct at the first attempt.

# components.schemas.API_Assessment.API.InVideoQuestionAnalysisDetail.description
detailed analysis for individual question in in-video assessment

# components.schemas.API_Assessment.API.InVideoQuestionAnalysis.properties.completed.description
the total progress. 100% means all students have tried all questions

# components.schemas.API_Assessment.API.InVideoQuestionAnalysis.properties.attemptedMoreThanOnce.description
total difficulty of the in-video quiz. Higher value means more students did not get the question correct at the first attempt.

# components.schemas.API_Assessment.API.InVideoQuestionAnalysis.description
question analysis for in-video assessment

# components.schemas.contract.Question.API.Question.properties.resourceID.description
ID of the tool or folder which contains this question, could be survey id or module id

# components.schemas.contract.Question.API.Question.properties.parentID.description
parent of the question id, could be section id if it is different from question ID

# components.schemas.contract.Question.API.Question.properties.type.description
type of the question:

Constant Sum Question                   - COS

Essay Question                          - ESS

Fill-In-The-Blank Question              - FIB

True or False Question                  - TOF

Single Selection Question in Radio      - MCQ

Single Selection Question in Dropdown   - SEL

Multiple Selection Choice Question      - MRQ

Matching Question                       - MCH

Oridinal Question                       - ORD

Likert's Scale Question                 - LKS

Semantic Differential Question          - SED

# components.schemas.contract.Question.API.Question.properties.forAssessment.description
Whether the question created for assessment

# components.schemas.contract.Question.API.Question.properties.solution.description
question solution or feedback, used for assessment question, which displayed after student completed the assessment

# components.schemas.contract.Question.API.Question.properties.publish.description
indicate whether the question is published

# components.schemas.contract.Question.API.Question.properties.requireRationale.description
allow student to enter rationale for the answer.

# components.schemas.contract.Question.API.Question.properties.difficultyLevel.description
Difficulty level of the question, 0 - Easy, 1 - Normal, 2 - Difficult. Used for assessment question.

# components.schemas.contract.Question.API.Question.properties.videoTimeStamp.description
the timestamp(in seconds) set for the in-video quiz

# components.schemas.contract.Question.API.Question.properties.lastUpdatedBy.description
Name of the user who modified the question last time

# components.schemas.contract.Question.API.Question.description
base question model, can have multiple variations with additional properties

# components.schemas.contract.Question.API.TOFQuestion.properties.correctAnswer.description
correct answer set for assessment question, true means "True" option is the correct answer.

# components.schemas.contract.Question.API.TOFQuestion.properties.negativeMarking.description
whether the question is allow negative marking,0 or null means negative marking is not set.

# components.schemas.contract.Question.API.TOFQuestion.properties.resourceID.description
ID of the tool or folder which contains this question, could be survey id or module id

# components.schemas.contract.Question.API.TOFQuestion.properties.parentID.description
parent of the question id, could be section id if it is different from question ID

# components.schemas.contract.Question.API.TOFQuestion.properties.forAssessment.description
Whether the question created for assessment

# components.schemas.contract.Question.API.TOFQuestion.properties.solution.description
question solution or feedback, used for assessment question, which displayed after student completed the assessment

# components.schemas.contract.Question.API.TOFQuestion.properties.publish.description
indicate whether the question is published

# components.schemas.contract.Question.API.TOFQuestion.properties.requireRationale.description
allow student to enter rationale for the answer.

# components.schemas.contract.Question.API.TOFQuestion.properties.difficultyLevel.description
Difficulty level of the question, 0 - Easy, 1 - Normal, 2 - Difficult. Used for assessment question.

# components.schemas.contract.Question.API.TOFQuestion.properties.videoTimeStamp.description
the timestamp(in seconds) set for the in-video quiz

# components.schemas.contract.Question.API.TOFQuestion.properties.lastUpdatedBy.description
Name of the user who modified the question last time

# components.schemas.contract.Question.API.TOFQuestion.description
input and output model for true/false question

# components.schemas.contract.Question.API.MarkingScheme.description
different marking scheme for check list selection

# components.schemas.contract.Question.API.ChoiceOption.properties.feedback.description
feedback text when this option is selected, used in assessment

# components.schemas.contract.Question.API.ChoiceOption.properties.hint.description
hint displayed for this option, used in assessment

# components.schemas.contract.Question.API.ChoiceOption.properties.isCorrect.description
Indicate whether this option is a correct answer

# components.schemas.contract.Question.API.ChoiceQuestion.properties.type.description
type of the question: MCQ - Radiobutton list for selection, MRQ - checkbox list for selection, SEL - dropdown list for selection

# components.schemas.contract.Question.API.ChoiceQuestion.properties.recommendMarkingScheme.description
recommented marking scheme, if the question is a MRQ question and it is used for assessment.

0 - if user selected any of the incorrect answers, he/she will get 0 mark or negative marks.

1 - user must select all the correct answers to get full marks, otherwise he/she will get 0 mark or negative marks

2 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * number-of-selected-correct-option/total-number-of-correct options. used together with RestrictSelection

3 - if user selected correct and incorrect answers, he/she will get partial marks = full-mark * (number-of-selected-correct-option - number-of-selected-incorrect-option)/total-number-of-correct options.

# components.schemas.contract.Question.API.ChoiceQuestion.properties.negativeMarking.description
whether the question is allow negative marking,0 or null means negative marking is not set.

# components.schemas.contract.Question.API.ChoiceQuestion.properties.restrictSelection.description
the maximum number of options can be selected by the user.

# components.schemas.contract.Question.API.ChoiceQuestion.properties.otherOptionText.description
the instructional text for that additional text box, if any

# components.schemas.contract.Question.API.ChoiceQuestion.properties.resourceID.description
ID of the tool or folder which contains this question, could be survey id or module id

# components.schemas.contract.Question.API.ChoiceQuestion.properties.parentID.description
parent of the question id, could be section id if it is different from question ID

# components.schemas.contract.Question.API.ChoiceQuestion.properties.forAssessment.description
Whether the question created for assessment

# components.schemas.contract.Question.API.ChoiceQuestion.properties.solution.description
question solution or feedback, used for assessment question, which displayed after student completed the assessment

# components.schemas.contract.Question.API.ChoiceQuestion.properties.publish.description
indicate whether the question is published

# components.schemas.contract.Question.API.ChoiceQuestion.properties.requireRationale.description
allow student to enter rationale for the answer.

# components.schemas.contract.Question.API.ChoiceQuestion.properties.difficultyLevel.description
Difficulty level of the question, 0 - Easy, 1 - Normal, 2 - Difficult. Used for assessment question.

# components.schemas.contract.Question.API.ChoiceQuestion.properties.videoTimeStamp.description
the timestamp(in seconds) set for the in-video quiz

# components.schemas.contract.Question.API.ChoiceQuestion.properties.lastUpdatedBy.description
Name of the user who modified the question last time

# components.schemas.contract.Question.API.ChoiceQuestion.description
input and output model for choice/selection based questions

# components.schemas.contract.Question.API.EssayQuestion.properties.wordLimit.description
The word limit of the user's answer if set

# components.schemas.contract.Question.API.EssayQuestion.properties.characterLimit.description
The character limit of the user's answer if set

# components.schemas.contract.Question.API.EssayQuestion.properties.answerWordsKeyMatch.description
The keyword list of a correct answers for assessment question.

# components.schemas.contract.Question.API.EssayQuestion.properties.allowHtmlAnswer.description
indicate whether to allow student type html content as the answer.

# components.schemas.contract.Question.API.EssayQuestion.properties.rubricID.description
Rubric Id if this question is marked by rubric. used for normal quiz

# components.schemas.contract.Question.API.EssayQuestion.properties.resourceID.description
ID of the tool or folder which contains this question, could be survey id or module id

# components.schemas.contract.Question.API.EssayQuestion.properties.parentID.description
parent of the question id, could be section id if it is different from question ID

# components.schemas.contract.Question.API.EssayQuestion.properties.forAssessment.description
Whether the question created for assessment

# components.schemas.contract.Question.API.EssayQuestion.properties.solution.description
question solution or feedback, used for assessment question, which displayed after student completed the assessment

# components.schemas.contract.Question.API.EssayQuestion.properties.publish.description
indicate whether the question is published

# components.schemas.contract.Question.API.EssayQuestion.properties.requireRationale.description
allow student to enter rationale for the answer.

# components.schemas.contract.Question.API.EssayQuestion.properties.difficultyLevel.description
Difficulty level of the question, 0 - Easy, 1 - Normal, 2 - Difficult. Used for assessment question.

# components.schemas.contract.Question.API.EssayQuestion.properties.videoTimeStamp.description
the timestamp(in seconds) set for the in-video quiz

# components.schemas.contract.Question.API.EssayQuestion.properties.lastUpdatedBy.description
Name of the user who modified the question last time

# components.schemas.contract.Question.API.EssayQuestion.description
input and output model for essay question

# components.schemas.contract.Question.API.FIBAnswer.properties.isNumericAnswer.description
indicate whether the answer is a numeric range or a text based answer

# components.schemas.contract.Question.API.FIBAnswer.properties.numericRangeMinValue.description
the minumum value which to be accepted as correct answer, this is used together with NumericRangeMaxValue

# components.schemas.contract.Question.API.FIBAnswer.properties.numericRangeMaxValue.description
the maxinum value which to be accepted as correct answer, this is used together with NumericRangeMinValue

# components.schemas.contract.Question.API.FIBOption.properties.answer.description
list of corrects answer for this blank, user will get full mark for this blank if the answer is matched with one of list

# components.schemas.contract.Question.API.FIBOption.properties.caseSensitive.description
indicate whether the correct answer should be evaluated in a case sensitive way, used when the answer is text answer.

# components.schemas.contract.Question.API.FIBOption.properties.characterLimit.description
the maximum character limit for user to enter for this blank.

# components.schemas.contract.Question.API.FIBOption.properties.onlyNumericAnswers.description
to indicate to UI whether this blank only allow numeric answers

# components.schemas.contract.Question.API.FIBOption.description
option for fill-in-the-blank questions,used for assessment

# components.schemas.contract.Question.API.FIBQuestion.properties.answersAndFeedbacks.description
FIB answes and feedbacks for assessment question

# components.schemas.contract.Question.API.FIBQuestion.properties.requireAllCorrect.description
students are required to answer all blanks correctly in order to obtain any score. used for assessment only

# components.schemas.contract.Question.API.FIBQuestion.properties.resourceID.description
ID of the tool or folder which contains this question, could be survey id or module id

# components.schemas.contract.Question.API.FIBQuestion.properties.parentID.description
parent of the question id, could be section id if it is different from question ID

# components.schemas.contract.Question.API.FIBQuestion.properties.forAssessment.description
Whether the question created for assessment

# components.schemas.contract.Question.API.FIBQuestion.properties.solution.description
question solution or feedback, used for assessment question, which displayed after student completed the assessment

# components.schemas.contract.Question.API.FIBQuestion.properties.publish.description
indicate whether the question is published

# components.schemas.contract.Question.API.FIBQuestion.properties.requireRationale.description
allow student to enter rationale for the answer.

# components.schemas.contract.Question.API.FIBQuestion.properties.difficultyLevel.description
Difficulty level of the question, 0 - Easy, 1 - Normal, 2 - Difficult. Used for assessment question.

# components.schemas.contract.Question.API.FIBQuestion.properties.videoTimeStamp.description
the timestamp(in seconds) set for the in-video quiz

# components.schemas.contract.Question.API.FIBQuestion.properties.lastUpdatedBy.description
Name of the user who modified the question last time

# components.schemas.contract.Question.API.FIBQuestion.description
intput and output model fill-in-the-blank question

# components.schemas.contract.Question.API.MatchingOption.properties.matchingValue.description
the correct value this option should be matched to.

# components.schemas.contract.Question.API.MarchingQuestion.properties.forAssessment.description
Whether the question created for assessment

# components.schemas.contract.Question.API.MarchingQuestion.properties.incorrectAnswers.description
incorrect answers used to combine with the value list

# components.schemas.contract.Question.API.MarchingQuestion.properties.resourceID.description
ID of the tool or folder which contains this question, could be survey id or module id

# components.schemas.contract.Question.API.MarchingQuestion.properties.parentID.description
parent of the question id, could be section id if it is different from question ID

# components.schemas.contract.Question.API.MarchingQuestion.properties.solution.description
question solution or feedback, used for assessment question, which displayed after student completed the assessment

# components.schemas.contract.Question.API.MarchingQuestion.properties.publish.description
indicate whether the question is published

# components.schemas.contract.Question.API.MarchingQuestion.properties.requireRationale.description
allow student to enter rationale for the answer.

# components.schemas.contract.Question.API.MarchingQuestion.properties.difficultyLevel.description
Difficulty level of the question, 0 - Easy, 1 - Normal, 2 - Difficult. Used for assessment question.

# components.schemas.contract.Question.API.MarchingQuestion.properties.videoTimeStamp.description
the timestamp(in seconds) set for the in-video quiz

# components.schemas.contract.Question.API.MarchingQuestion.properties.lastUpdatedBy.description
Name of the user who modified the question last time

# components.schemas.contract.Question.API.MarchingQuestion.description
input and output model for matching question

# components.schemas.API_Assessment.API.QuestionMark.properties.negativeMarking.description
whether the question is allow negative marking,0 or null means negative marking is not set.

# components.schemas.API_Assessment.API.QuestionStamp.properties.videoTimeStamp.description
the timestamp(in seconds) set for the in-video quiz

# components.schemas.API_Assessment.API.InputTimeStamp.description
update time stamp for each question in in-video assessment

# components.schemas.API_Assessment.API.Response.properties.userId.description
login id of the user who made the answer

# components.schemas.API_Assessment.API.Response.properties.userMatrixNo.description
matrix number of the user who made the answer

# components.schemas.API_Assessment.API.Response.properties.mark.description
marks calculated by system or set by lecturer

# components.schemas.API_Assessment.API.Response.properties.scoredBy.description
Id of the user who marked the response (Mark and Comment)

# components.schemas.API_Assessment.API.Response.properties.markerUserName.description
Name of the user who marked the response (Mark and Comment)

# components.schemas.API_Assessment.API.Response.properties.markerUserId.description
login id of the user who marked the response (Mark and Comment)

# components.schemas.API_Assessment.API.Response.properties.options.description
Order value of selected options for Choice questions: eg [3, 1], starting number of order is 1.

# components.schemas.API_Assessment.API.Response.properties.lstAnswer.description
answer for fill in the blank question or matched values for matching question

# components.schemas.API_Assessment.API.Response.properties.rational.description
rational content for the answer, userd for normal assessment

# components.schemas.API_Assessment.API.Response.properties.skipQuestion.description
whether user has skipped this question, used for question with negative marking

# components.schemas.API_Assessment.API.Response.description
answers user made on a assessment question

# components.schemas.API_Assessment.API.InputResponseWithTimer.properties.options.description
Order value of selected options for Choice questions: eg [3, 1], starting number of order is 1.

# components.schemas.API_Assessment.API.InputResponseWithTimer.properties.lstAnswer.description
answer for fill in the blank question or matched values for matching question

# components.schemas.API_Assessment.API.InputResponseWithTimer.properties.rational.description
rational content for the answer, userd for normal assessment

# components.schemas.API_Assessment.API.InputResponseWithTimer.properties.skipQuestion.description
whether user has skipped this question, used for question with negative marking

# components.schemas.API_Assessment.API.InputResponseWithMark.properties.mark.description
marks calculated by system or set by lecturer

# components.schemas.API_Assessment.API.InputResponseWithMark.properties.userMarkDetail.description
List of marking/comments for the rubric of the receiver. Applicable if question is scored by rubric.

# components.schemas.API_Assessment.API.InputResponseWithMark.properties.options.description
Order value of selected options for Choice questions: eg [3, 1], starting number of order is 1.

# components.schemas.API_Assessment.API.InputResponseWithMark.properties.lstAnswer.description
answer for fill in the blank question or matched values for matching question

# components.schemas.API_Assessment.API.InputResponseWithMark.properties.rational.description
rational content for the answer, userd for normal assessment

# components.schemas.API_Assessment.API.InputResponseWithMark.properties.skipQuestion.description
whether user has skipped this question, used for question with negative marking

# components.schemas.API_Assessment.API.InputResponseWithMark.description
lecturer overwrite student response with marks(optional) information

# components.schemas.API_Assessment.API.InputResponses.properties.endSession.description
true means user would like to submit/end the session

# components.schemas.API_Assessment.API.InputResponses.description
user answers on multiple assessment questions

# components.schemas.API_Assessment.API.InputResponse.properties.options.description
Order value of selected options for Choice questions: eg [3, 1], starting number of order is 1.

# components.schemas.API_Assessment.API.InputResponse.properties.lstAnswer.description
answer for fill in the blank question or matched values for matching question

# components.schemas.API_Assessment.API.InputResponse.properties.rational.description
rational content for the answer, userd for normal assessment

# components.schemas.API_Assessment.API.InputResponse.properties.skipQuestion.description
whether user has skipped this question, used for question with negative marking

# components.schemas.API_Assessment.API.InputMark.properties.mark.description
marks calculated by system or set by lecturer

# components.schemas.API_Assessment.API.InputMark.properties.userMarkDetail.description
List of marking/comments for the rubric of the receiver. Applicable if question is scored by rubric.

# components.schemas.API_Assessment.API.InputMarks.description
add marks and comments for multiple answers

# components.schemas.API_Assessment.API.Section.properties.assessmentId.description
id of the assessment this section belongs to

# components.schemas.API_Assessment.API.Section.properties.displayQuestionMark.description
whether to display the marks for each question for this section.

# components.schemas.API_Assessment.API.Section.properties.displayedRandomQuestions.description
used only when RandomizeQuestions is set to true. 
if the number is specified, system will randomly choose the specified number of questions from this section and display. otherwise all questions in this section will be displayed in randomized order.

# components.schemas.API_Assessment.API.Section.properties.randomizeQuestions.description
allow system to randomly choose questions and display.

# components.schemas.API_Assessment.API.Section.properties.randomizeOptions.description
allow system to display options in the question with a ranomized order.

# components.schemas.API_Assessment.API.Section.properties.requireRational.description
allow student to enter rantional for the answer.

# components.schemas.API_Assessment.API.InputSectionForCreate.properties.assessmentId.description
id of the assessment this section belongs to

# components.schemas.API_Assessment.API.InputSectionForCreate.properties.displayQuestionMark.description
whether to display the marks for each question for this section.

# components.schemas.API_Assessment.API.InputSectionForCreate.properties.displayedRandomQuestions.description
used only when RandomizeQuestions is set to true. 
if the number is specified, system will randomly choose the specified number of questions from this section and display. otherwise all questions in this section will be displayed in randomized order.

# components.schemas.API_Assessment.API.InputSectionForCreate.properties.randomizeQuestions.description
allow system to randomly choose questions and display.

# components.schemas.API_Assessment.API.InputSectionForCreate.properties.randomizeOptions.description
allow system to display options in the question with a ranomized order.

# components.schemas.API_Assessment.API.InputSectionForCreate.properties.requireRational.description
allow student to enter rantional for the answer.

# components.schemas.API_Assessment.API.InputSectionForUpdate.properties.displayQuestionMark.description
whether to display the marks for each question for this section.

# components.schemas.API_Assessment.API.InputSectionForUpdate.properties.displayedRandomQuestions.description
used only when RandomizeQuestions is set to true. 
if the number is specified, system will randomly choose the specified number of questions from this section and display. otherwise all questions in this section will be displayed in randomized order.

# components.schemas.API_Assessment.API.InputSectionForUpdate.properties.randomizeQuestions.description
allow system to randomly choose questions and display.

# components.schemas.API_Assessment.API.InputSectionForUpdate.properties.randomizeOptions.description
allow system to display options in the question with a ranomized order.

# components.schemas.API_Assessment.API.InputSectionForUpdate.properties.requireRational.description
allow student to enter rantional for the answer.

# components.schemas.API_Assessment.API.StudentProgress.properties.status.description
Status value could be: Completed, Incomplete, Not Taken

# components.schemas.API_Assessment.API.StudentProgress.description
give a list of student with progress on this quiz.

# components.schemas.API_Assessment.API.Session.properties.startDate.description
the time when user start taking the assessment

# components.schemas.API_Assessment.API.Session.properties.completedDate.description
the time when user finish taking the assessment

# components.schemas.API_Assessment.API.Session.properties.duration.description
time taken in seconds, used for time-limit assessment

# components.schemas.API_Assessment.API.Session.properties.timeLeft.description
time left in seconds to take the quiz, used for time-limit assessment

# components.schemas.API_Assessment.API.Session.properties.score.description
score summed from all questions for this session

# components.schemas.API_Assessment.API.Session.description
user attempted session on the assessment

# components.schemas.API_Assessment.API.InputSessionMark.description
moderation and overall comments set for the student session

# components.schemas.API_Assessment.API.TimeExtension.description
extend time limit for a specific student

# components.schemas.API_Assessment.API.InputTimeExtension.description
set the time extesion for a specific student