POST - Publish Result
The Publish Result API allows the publication of exam results in two states:
- Pre-publish: Marks and performance details are shared with stakeholders for validation and feedback before finalizing the results.
- Final-publish: The final and locked results are published after necessary validations.
This API facilitates the seamless transition between provisional and final states in the evaluation process.
Scenarios:
-
Pre-Publish Exam Results for Stakeholder Review:
- After scoring student answer sheets and generating preliminary results, the teacher or administrator wants to share the results for review and feedback.
- The API is used to pre-publish the results in a ‘pre-publish’ state, enabling stakeholders (e.g., teachers, moderators) to validate the marks and performance details.
- Outcome:
- Stakeholders can review the provisional results, verify accuracy, and suggest any necessary adjustments before finalizing the results.
-
Final Publish of Exam Results After Validation:
- After incorporating feedback from stakeholders, the teacher or administrator finalizes and approves the results.
- The API is used to final-publish the exam results, locking the results and marking them as final.
- Outcome:
- The final exam results are officially published, and no further changes can be made. The results are now available to students and other relevant parties in a definitive format.
POST
Publish the result of an exam
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Request body for final publish operation.
The entity to be published either as a pre-publish or final-publish.
Example:
"final-publish"
Response
Success
Example:
"Successfully {{entity}} result"
Previous
GET - Provisional Mark Sheet The API retrieves detailed provisional scores for a student's exam. This includes:
- Exam-level metadata (exam name, subject, total marks, etc.).
- Section-wise summaries (marks distribution and instructions).
- Detailed breakdown of student answers, model answers, step-wise marking, and feedback.
This API helps educators review scores and provide feedback before finalizing and publishing results.
**Scenarios:**
1. **Reviewing Provisional Scores Before Finalizing:**
- A teacher reviews the provisional scores of a specific student before finalizing the results.
- The API provides:
- **Exam-Level Metadata:** Information like exam name, subject, and total marks.
- **Section-Wise Summaries:** Breakdown of marks distribution and instructions for each section.
- **Detailed Breakdown:** Student answers, model answers, step-wise marking, and feedback for each question.
- **Outcome:**
- The teacher reviews the provisional scores, adjusts as needed, and prepares to finalize the results for publication.
2. **Providing Feedback on Provisional Scores:**
- A teacher uses this API to review and give feedback on provisional scores for a specific exam.
- The teacher can access detailed performance information, including step-wise marking and feedback.
- **Outcome:**
- The teacher offers personalized feedback to students, helping them understand their mistakes and providing guidance for improvement before results are finalized.
Next
Publish the result of an exam