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 userType, status, file types. This API is primarily used to fetch reference data for UI dropdowns, data validation, and workflow configurations.

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

assignment-evaluation

assignment

constant

cURL

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

{
  "userType": {
    "1": "Admin",
    "2": "Teacher",
    "3": "Student",
    "4": "Parent"
  },
  "status": {
    "0": "Open",
    "1": "In Progress",
    "2": "Completed",
    "3": "Failed"
  },
  "fileType": {
    "1": "pdf",
    "2": "jpeg"
  }
}

Authorizations

Authorization

string

header

required

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

Response

Metadata dictionaries fetched successfully.

userType

object

Mapping of user types by ID

Show child attributes

Example:

{
  "1": "Admin",
  "2": "Teacher",
  "3": "Student",
  "4": "Parent"
}

status

object

Mapping of assignment status codes

Show child attributes

Example:

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

fileType

object

Mapping of document type identifiers

Show child attributes

Example:

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

POST - Rubric This API allows authenticated users to create a new rubric by specifying a title and an optional description. **Key Notes:** - `name` is a required field. It defines the title of the rubric. - `description` is optional and can include additional context or instructions. - The created rubric is returned with metadata including `id`, `createdAt`, and `modifiedAt`. **Scenario: Creating a Rubric for an Assignment** A teacher wants to set up a new rubric to evaluate student essays. **Outcome:** - The teacher sends a POST request with the rubric title and description. - The rubric is saved and ready to be assigned criteria via the system. - This structure helps ensure consistent and transparent evaluation across students.

⌘I

cURL

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

{
  "userType": {
    "1": "Admin",
    "2": "Teacher",
    "3": "Student",
    "4": "Parent"
  },
  "status": {
    "0": "Open",
    "1": "In Progress",
    "2": "Completed",
    "3": "Failed"
  },
  "fileType": {
    "1": "pdf",
    "2": "jpeg"
  }
}

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

GET - Constants

Authorizations

Response