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.

POST

rubrics

rubric

Create Rubric

curl --request POST \
  --url https://api-staging.crazygoldfish.com/rubrics/v1/rubric/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "English Rubric",
  "description": "A rubric for evaluating english hand written assignment."
}
'

{
  "id": "2b973c83-2830-4712-87b7-64a8c0a99035",
  "name": "English Rubric",
  "description": "A rubric for evaluating english hand written assignment.",
  "rubricCriteria": [],
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

name

string

required

Name of the rubric

Example:

"English Rubric"

description

string

Description of the rubric

Example:

"A rubric for evaluating english hand written assignment."

Response

Rubric created successfully.

string

Unique ID of the rubric

Example:

"2b973c83-2830-4712-87b7-64a8c0a99035"

name

string

Name of the rubric

Example:

"English Rubric"

description

string

Description of the rubric

Example:

"A rubric for evaluating english hand written assignment."

rubricCriteria

array

List of rubric criteria

Example:

[]

createdAt

string<date-time>

Created date for the rubric

modifiedAt

string<date-time>

Modified date of the rubric

GET - Rubric Fetches the details of a specific rubric using its unique ID. This includes basic metadata like name and description, as well as an array of associated criteria with scoring logic. **Key Notes:** - `id` must be a valid UUID of an existing rubric. - Authentication is required via Bearer Token. - If the rubric is not found, a `404` error is returned. **Use Cases:** - Display rubric information in the frontend UI. - Load criteria for scoring assignments or assessments. - Pull rubric data into admin dashboards. **Response includes:** - `id`: Unique ID of the rubric. - `name`, `description` - `rubricCriteria`: Array of criteria with scoring logic. - `createdAt`, `modifiedAt` timestamps.

Create Rubric

curl --request POST \
  --url https://api-staging.crazygoldfish.com/rubrics/v1/rubric/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "English Rubric",
  "description": "A rubric for evaluating english hand written assignment."
}
'

{
  "id": "2b973c83-2830-4712-87b7-64a8c0a99035",
  "name": "English Rubric",
  "description": "A rubric for evaluating english hand written assignment.",
  "rubricCriteria": [],
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}