GET - Constants
The API provides a centralized repository of predefined constants for the evaluation platform. These constants ensure data consistency across APIs by standardizing values such as subjects, grades, file types, query statuses, and more. This API is primarily used to fetch reference data for UI dropdowns, data validation, and workflow configurations.
Scenario: Populating Dropdowns for Form Submission:
- Dynamic Dropdown Population:
- A teacher uploads results for an exam. The UI dynamically fetches options like Subjects (e.g., “Science,” “Math”), Grades (e.g., “First,” “Second”), and Exam Types (e.g., “Pre Boards”) from the Constants API.
- Outcome:
- The selected values are sent back in subsequent API calls, ensuring data consistency for form submissions.
Scenario: Validating File Upload and Status Management:
- Validating File Types and Status:
- A teacher uploads a file as part of the result evaluation process. The system uses predefined file types (e.g., “pdf,” “jpeg”) and file statuses (e.g., “Open,” “In Progress,” “Completed”) from the Constants API.
- Outcome:
- This ensures only valid file formats are uploaded and tracks the status of the file throughout the workflow.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Represents subject IDs mapped to subject names. Used for categorizing exams and answer sheets. Example: 1: Science
{
"1": "Science",
"2": "Math",
"3": "English",
"4": "Hindi"
}
Maps class IDs to their respective class names. Useful for organizing exams by grade level. Example: 10: Tenth
{
"1": "First",
"2": "Second",
"3": "Third",
"4": "Fourth",
"5": "Fifth",
"6": "Sixth",
"7": "Seventh",
"8": "Eighth",
"9": "Ninth",
"10": "Tenth",
"11": "Eleventh",
"12": "Twelfth"
}
Maps exam type IDs to descriptions. Example: 1: Pre Boards
{ "1": "Pre Boards" }
Represents the format of uploaded files. Example: 1: pdf, 2: docx, 3: jpeg
{ "1": "pdf", "2": "docx", "3": "jpeg" }
Indicates the status of a file being processed. Example: 0: Open, 2: Completed
{
"0": "Open",
"1": "In Progress",
"2": "Completed",
"3": "Failed"
}
Maps query types to their descriptions. Useful for managing user queries. Example: 1: Classification
{
"1": "Classification",
"2": "Re-evaluation Request",
"3": "Other Concerns"
}
Indicates the progress of a query.. Example: 1: Submitted, 3: Resolved
{
"1": "Submitted",
"2": "In Review",
"3": "Resolved"
}
Represents possible states for publishing results. Values: [pre-publish, final-publish]
["pre-publish", "final-publish"]
[
{
"type": "question",
"fields": ["text", "marks", "isApproved"]
},
{
"type": "parentQuestion",
"fields": ["text", "marks", "isApproved"]
},
{
"type": "modelAnswer",
"fields": ["text", "stepMarking", "isApproved"]
},
{
"type": "answer",
"fields": [
"text",
"marks",
"isApproved",
"updateReason"
]
}
]