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.

GET

evaluation-platform

constants

Get a list of available constants required in the evaluation.

curl --request GET \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/constants/ \
  --header 'Authorization: Bearer <token>'

{
  "subjects": {
    "1": "Science",
    "2": "Math",
    "3": "English",
    "4": "Hindi"
  },
  "grade": {
    "1": "First",
    "2": "Second",
    "3": "Third",
    "4": "Fourth",
    "5": "Fifth",
    "6": "Sixth",
    "7": "Seventh",
    "8": "Eighth",
    "9": "Ninth",
    "10": "Tenth",
    "11": "Eleventh",
    "12": "Twelfth"
  },
  "examType": {
    "1": "Pre Boards"
  },
  "fileType": {
    "1": "pdf",
    "2": "png",
    "3": "jpeg"
  },
  "fileStatus": {
    "0": "Open",
    "1": "In Progress",
    "2": "Completed",
    "3": "Failed"
  },
  "queryTypes": {
    "1": "Classification",
    "2": "Re-evaluation Request",
    "3": "Other Concerns"
  },
  "queryStatus": {
    "1": "Submitted",
    "2": "In Review",
    "3": "Resolved"
  },
  "publishTypeEntity": [
    "pre-publish",
    "final-publish"
  ],
  "updateEntityType": [
    {
      "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"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful response with metadata.

subjects

object

Represents subject IDs mapped to subject names. Used for categorizing exams and answer sheets. Example: 1: Science

Show child attributes

subjects.{key}

string

Example:

{
  "1": "Science",
  "2": "Math",
  "3": "English",
  "4": "Hindi"
}

grade

object

Maps class IDs to their respective class names. Useful for organizing exams by grade level. Example: 10: Tenth

Show child attributes

grade.{key}

string

Example:

{
  "1": "First",
  "2": "Second",
  "3": "Third",
  "4": "Fourth",
  "5": "Fifth",
  "6": "Sixth",
  "7": "Seventh",
  "8": "Eighth",
  "9": "Ninth",
  "10": "Tenth",
  "11": "Eleventh",
  "12": "Twelfth"
}

examType

object

Maps exam type IDs to descriptions. Example: 1: Pre Boards

Show child attributes

examType.{key}

string

Example:

{ "1": "Pre Boards" }

fileType

object

Represents the format of uploaded files. Example: 1: pdf, 2: png, 3: jpeg

Show child attributes

fileType.{key}

string

Example:

{ "1": "pdf", "2": "png", "3": "jpeg" }

fileStatus

object

Indicates the status of a file being processed. Example: 0: Open, 2: Completed

Show child attributes

fileStatus.{key}

string

Example:

{
  "0": "Open",
  "1": "In Progress",
  "2": "Completed",
  "3": "Failed"
}

queryTypes

object

Maps query types to their descriptions. Useful for managing user queries. Example: 1: Classification

Show child attributes

queryTypes.{key}

string

Example:

{
  "1": "Classification",
  "2": "Re-evaluation Request",
  "3": "Other Concerns"
}

queryStatus

object

Indicates the progress of a query.. Example: 1: Submitted, 3: Resolved

Show child attributes

queryStatus.{key}

string

Example:

{
  "1": "Submitted",
  "2": "In Review",
  "3": "Resolved"
}

publishTypeEntity

string[]

Represents possible states for publishing results. Values: [pre-publish, final-publish]

Example:

["pre-publish", "final-publish"]

updateEntityType

object[]

Show child attributes

updateEntityType.type

string

updateEntityType.fields

string[]

Example:

[
  {
    "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"
    ]
  }
]

PATCH - Update API This is a generic API that allows you to update various components of an evaluation platform: - You can update the question text to reflect any changes or corrections. - The marking scheme can be modified to adjust the scoring criteria. - Model answer step marking can be updated to ensure accurate evaluation. - Additionally, you can update the student evaluated answer marking for consistency **Scenario: Updating Question Text for Clarity or Correction:** 1. **Clarifying or Correcting Question Text:** - During the evaluation process, an evaluator identifies an ambiguous or incorrect question. The Generic Update API allows updating the question text to make it clearer or correct any inaccuracies. - **Outcome:** - The question text is updated, ensuring consistency across the platform and more accurate evaluation for students. **Scenario: Adjusting the Marking Scheme for a Specific Question:** 1. **Modifying the Marking Scheme:** - An evaluator reviews a question and decides to adjust the marking scheme, either by changing the total marks, modifying the breakdown, or adding new criteria. - **Outcome:** - The marking scheme is updated, ensuring fairness and alignment with evaluation criteria. **Scenario: Updating Model Answer’s Step Marking:** 1. **Modifying Step-Wise Marking:** - After reviewing the model answer, the evaluator notices the step marking needs to be adjusted for clarity or accuracy. The Generic Update API is used to modify how marks are distributed across different steps. - **Outcome:** - The step marking is updated, impacting how student answers are evaluated and ensuring accurate scoring. **Scenario: Correcting Student Answer Evaluation Marking:** 1. **Correcting Mistakes in Evaluation:** - After reviewing a student’s answer, an error is discovered in the evaluation, such as incorrect marking or wrong application of the model answer’s step-wise evaluation. - **Outcome:** - The student’s evaluated answer is corrected, ensuring that the final score accurately reflects the correct evaluation based on the model answer.

⌘I

Get a list of available constants required in the evaluation.

curl --request GET \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/constants/ \
  --header 'Authorization: Bearer <token>'

{
  "subjects": {
    "1": "Science",
    "2": "Math",
    "3": "English",
    "4": "Hindi"
  },
  "grade": {
    "1": "First",
    "2": "Second",
    "3": "Third",
    "4": "Fourth",
    "5": "Fifth",
    "6": "Sixth",
    "7": "Seventh",
    "8": "Eighth",
    "9": "Ninth",
    "10": "Tenth",
    "11": "Eleventh",
    "12": "Twelfth"
  },
  "examType": {
    "1": "Pre Boards"
  },
  "fileType": {
    "1": "pdf",
    "2": "png",
    "3": "jpeg"
  },
  "fileStatus": {
    "0": "Open",
    "1": "In Progress",
    "2": "Completed",
    "3": "Failed"
  },
  "queryTypes": {
    "1": "Classification",
    "2": "Re-evaluation Request",
    "3": "Other Concerns"
  },
  "queryStatus": {
    "1": "Submitted",
    "2": "In Review",
    "3": "Resolved"
  },
  "publishTypeEntity": [
    "pre-publish",
    "final-publish"
  ],
  "updateEntityType": [
    {
      "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"
      ]
    }
  ]
}

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

GET - Constants

Authorizations

Response