Exams
Exam List
Use this API to list all upcoming, ongoing or past exams.
GET /exam/{userId}/trainee-exam-list Try now
Path parameters
| Field | Type | Description |
|---|---|---|
| userId required | integer | User ID |
Query string parameters
| Field | Type | Description |
|---|---|---|
| type required | integer |
|
| examId | integer | examId is required when type = 3 |
| q | string | filter data by title |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"examList": [
{
"enrollmentId": 706283,
"examScheduleId": 139853,
"examId": 1,
"examTitle": "Principle Of Effective Manager",
"examInstruction": "<p>EXAM INSTRUCTIONS:</p><p>1) Exam duration is for 40 minutes.</p><p>2) Exam is for 25 Marks and the required Passing Marks are 15.</p><p>3) In case of disconnection due to network failure or power outage you can login and continue the exam by clicking Continue</p><p>(Note: Time lost due to network failure or power outage is not compensated.)</p><p>4) For technical issues during exam you can mail to info@alphalearn.com.</p><p>5) Read the question and click on the right answer and press next to proceed to the next question.</p><p>6) You will see the attempted questions appearing in green on the right-hand top corner.</p><p>7) In case you do not know the answer you may flag the question and come back to answer the same.</p><p>8) You may also make changes in any specific answer if you have rethought your option.</p><p>9) This Post-assessment is available till 23rd February'21.</p><p>10) If you attempt to minimize or change the tab during an ongoing exam more than 5 times, you will receive a pop-up notification with a warning on the screen and the exam will immediately end.</p>",
"examStartDate": "2023-08-29",
"examEndDate": "2023-09-02",
"examAttemptedDate": "0000-00-00 00:00:00",
"examSubmitedDate": "0000-00-00 00:00:00",
"examScheduleStatus": 0,
"userExamActivityId": null,
"totalQuestion": 10,
"isProctor": true,
"totalMarks": 10,
"examDuration": 10,
"isprogresshundred": "1",
"enrollmentEndDate": "2023-09-28",
"completedPercent": "41",
"action": {
"canStart": false,
"comment": "Webcam Proctored Exam cannot be attempted using a mobile device."
}
}
],
"lastAttemptedExam": null
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| examList | array | List of exams available. |
| enrollmentId | number | ID for the enrollment. |
| examScheduleId | number | ID for the exam schedule. |
| examId | number | ID for the exam. |
| examTitle | string | Title of the exam. |
| examInstruction | string | Instructions for the exam. |
| examStartDate | string | Start date of the exam (YYYY-MM-DD). |
| examEndDate | string | End date of the exam (YYYY-MM-DD). |
| examAttemptedDate | string | Date when the exam was attempted (YYYY-MM-DD HH:MM:SS). |
| examSubmitedDate | string | Date when the exam was submitted (YYYY-MM-DD HH:MM:SS). |
| examScheduleStatus | number | Status of the exam schedule. |
| userExamActivityId | null or number | ID for user exam activity or null if not applicable. |
| totalQuestion | number | Total number of questions in the exam. |
| isProctor | boolean | Indicates whether the exam is proctored. |
| totalMarks | number | Total marks available for the exam. |
| examDuration | number | Duration of the exam in minutes. |
| isprogresshundred | string | Progress status of the exam. |
| enrollmentEndDate | string | End date of enrollment for the exam (YYYY-MM-DD). |
| completedPercent | string | Percentage of completion for the exam. |
| action.canStart | boolean | Indicates whether the exam can be started. |
| action.comment | string | Comment related to starting the exam (e.g., device compatibility). |
| lastAttemptedExam | null | Information about the last attempted exam or null if no exam has been attempted. |
| Code | Description |
|---|---|
| 1003 | "Missing type" |
| 1004 | "Invalid type" |
| 1025 | "Missing examId" |
| 1026 | "Invalid examId" |
Exam Start
Use this API to start an exam.
GET /exam/{examId}/start Try now
Path parameters
| Field | Type | Description |
|---|---|---|
| examId required | integer | Exam ID |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"examDetails": {
"interruptSetting": {
"browser": {
"enable": true,
"maxInterruptionCount": 5,
"myInterruptionCount": 0
},
"proctor": {
"enable": false,
"maxInterruptionCount": 5,
"showAlerIfFaceNotDetectedInSecond": 30,
"captureIntervalInMinutes": 10,
"myInterruptionCount": 0
}
},
"userExamActivityId": 33910,
"examId": 299,
"examTitle": "B2B Sales Management",
"examScheduleId": 139869,
"startDate": "2023-08-30",
"endDate": "2023-09-14",
"duration": 15,
"totalQuestion": 10,
"totalMarks": 30,
"passingMarks": 20,
"attempted": 0,
"correct": 0,
"timeLeftInSeconds": 900
},
"questions": [
{
"questionBody": "How to mearsure an Equity Risk",
"queMark": 5,
"single_multiple": 1,
"options": [
{
"option": "Beta"
},
{
"option": "Standard Deviation"
},
{
"option": "VAR"
},
{
"option": "All of the Above"
}
],
"questionId": 22405,
"isFlag": false,
"userAnswer": null
},
]
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| examDetails | object | Details about the exam. |
| interruptSetting | object | Settings related to interruptions during the exam. |
| browser | object | Browser interruption settings. |
| enable | boolean | Indicates whether browser interruptions are enabled. |
| maxInterruptionCount | number | Maximum allowed interruptions in the browser. |
| myInterruptionCount | number | Number of interruptions in the browser for the user. |
| proctor | object | Proctor interruption settings. |
| enable | boolean | Indicates whether proctor interruptions are enabled. |
| maxInterruptionCount | number | Maximum allowed interruptions for the proctor. |
| showAlerIfFaceNotDetectedInSecond | number | Time in seconds to show alert if face is not detected during proctoring. |
| captureIntervalInMinutes | number | Interval in minutes for capturing proctoring data. |
| myInterruptionCount | number | Number of interruptions for the user in proctoring. |
| userExamActivityId | number | ID of the user's exam activity. |
| examId | number | ID of the exam. |
| examTitle | string | Title of the exam. |
| examScheduleId | number | ID of the exam schedule. |
| startDate | string | Start date of the exam. |
| endDate | string | End date of the exam. |
| duration | number | Duration of the exam in minutes. |
| totalQuestion | number | Total number of questions in the exam. |
| totalMarks | number | Total marks for the exam. |
| passingMarks | number | Marks required to pass the exam. |
| attempted | number | Number of questions attempted by the user. |
| correct | number | Number of questions answered correctly by the user. |
| timeLeftInSeconds | number | Time left in seconds for the user to complete the exam. |
| questions | array | Array of question objects. |
| questionBody | string | Text of the question. |
| queMark | number | Marks assigned to the question. |
| single_multiple | number | Indicates whether the question is single or multiple choice. |
| options | array | Array of option objects for multiple-choice questions. |
| option | string | Text of the option. |
| questionId | number | ID of the question. |
| isFlag | boolean | Indicates if the question is flagged. |
| userAnswer | null | User's answer to the question. |
Submit Exam Answers
Use this API to submit answers, clear answers, flag questions.
POST /exam/trainee-question-action Try now
Request body parameters
| Field | Type | Description |
|---|---|---|
| type required | integer |
|
| userExamActivityId required | integer | The user exam activiy ID |
| questionId required | integer | The question ID |
| answerOption required | integer | The answer |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": true,
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| data | boolean | Indicates whether answer saved or not. |
| Code | Description |
|---|---|
| 1003 | "Missing type" |
| 1004 | "Invalid type" |
| 1009 | "Missing userExamActivityId" |
| 1010 | "Invalid userExamActivityId" |
| 1011 | "Missing questionId" |
| 1012 | "Invalid questionId" |
| 1013 | "Missing answerOption" |
| 1014 | "Invalid answerOption" |
Interrupt Exam
Use this API to capture browser minimize event.
POST /exam/trainee-exam-interrupt Try now
Request body parameters
| Field | Type | Description |
|---|---|---|
| type required | integer |
|
| userExamActivityId required | integer | The user exam activiy ID |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"forceToSubmitExam": false,
"eventCount": 1
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| forceToSubmitExam | boolean | Indicates if the user is forced to submit the exam. |
| eventCount | number | Count of events in the response data. |
| Code | Description |
|---|---|
| 1003 | "Missing type" |
| 1004 | "Invalid type" |
| 1009 | "Missing userExamActivityId" |
| 1010 | "Invalid userExamActivityId" |
Submit/End Exam
Use this API to submit/end an exam.
GET /exam/{userExamActivityId}/complete Try now
Path parameters
| Field | Type | Description |
|---|---|---|
| userExamActivityId required | integer | The userExamActivityId |
Query string parameters
| Field | Type | Description |
|---|---|---|
| submittedBy required | integer |
|
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": null,
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| data | null | if exam ends, it will be null |
| Code | Description |
|---|---|
| 1030 | "Missing submittedBy" |
| 1031 | "Invalid submittedBy" |
View Exam Answer sheet
Use this API to view exam answer sheet listing the questions and attempted answers.
GET /exam/{userExamActivityId}/view-exam-paper Try now
Path parameters
| Field | Type | Description |
|---|---|---|
| userExamActivityId required | integer | The userExamActivityId |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"examDetails": {
"examId": 4,
"examTitle": "Human Resource Management",
"totalMarks": 6,
"totalQuestion": 6,
"passingMarks": 4,
"attempted": 6,
"correct": 4,
"obtainedMarks": 4,
"examAttemptedDate": "2023-08-23 15:30:07",
"examDuration": 30
},
"questions": [
{
"questionBody": "__________ arises when two people or groups have dissenting views on moral values-that basic understanding of what is naturally right or wrong.",
"queMark": "1",
"single_multiple": "1",
"options": [
{
"examQuestionID": "27",
"eoption": "minor offences"
},
{
"examQuestionID": "27",
"eoption": "major offences"
},
{
"examQuestionID": "27",
"eoption": "all offences"
},
{
"examQuestionID": "27",
"eoption": "None of the above"
}
],
"questionId": 27,
"isFlag": false,
"userAnswer": "1",
"correctOptionIs": "1"
}
]
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| examDetails | object | Details about the exam. |
| examId | number | ID of the exam. |
| examTitle | string | Title of the exam. |
| totalMarks | number | Total marks for the exam. |
| totalQuestion | number | Total number of questions in the exam. |
| passingMarks | number | Marks required to pass the exam. |
| attempted | number | Number of questions attempted by the user. |
| correct | number | Number of questions answered correctly. |
| obtainedMarks | number | Marks obtained by the user. |
| examAttemptedDate | string | Date and time when the exam was attempted. |
| examDuration | number | Duration of the exam in minutes. |
| questions | array | Array of question objects. |
| questionBody | string | Text of the question. |
| queMark | string | Marks assigned to the question. |
| single_multiple | string | Type of question (single/multiple choice). |
| options | array | Array of option objects for multiple-choice questions. |
| examQuestionID | string | ID of the exam question. |
| eoption | string | Text of the option. |
| questionId | number | ID of the question. |
| isFlag | boolean | Indicates if the question is flagged. |
| userAnswer | string | User's answer to the question. |
| correctOptionIs | string | Correct option for the question. |