LIST - Rubric

This API allows authenticated users to retrieve a paginated list of rubrics they have created.

Key Notes:

Supports pagination with metadata like count, pageSize, next, and previous.
Each rubric object includes fields like id, name, description, createdAt, modifiedAt, and rubricCriteria.

Scenario: Viewing Available Rubrics

A teacher wants to see all the rubrics they’ve created to select one for a new assignment.

Outcome:

The teacher sends a GET request.
The API responds with a list of rubrics along with pagination info.
The teacher can choose and manage existing rubrics efficiently.

GET

rubrics

rubric

Get Rubric List

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

{
  "count": 20,
  "pageSize": 10,
  "showing": "Page 1 of 2",
  "next": "{{base_url}}/rubrics/v1/rubric/?page=2",
  "previous": null,
  "data": [
    {
      "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.

Response

List of rubrics retrieved successfully.

count

integer

Total number of assignment available.

Example:

20

pageSize

integer

Number of items displayed per page.

Example:

10

showing

string

Current page display information.

Example:

"Page 1 of 2"

string<uri> | null

URL for the next page of results.

Example:

"{{base_url}}/rubrics/v1/rubric/?page=2"

string<uri> | null

URL for the previous page of results.

Example:

null

data

object[]

Show child attributes

POST - Rubric Criteria This API allows authenticated users to add a new criteria to an existing rubric by specifying its title, score range, and detailed scoring logic. **Key Notes:** - `name`, `maxScore`, and `minScore` are **required** fields. - `scoringLogic` is an array of objects, each containing a `score` and its associated `scoringLogic` explanation. - This helps maintain a transparent and consistent evaluation framework. **Scenario: Adding a Criterion to a Rubric** A teacher wants to assess 'Confidence & fluency in speaking' in a student presentation rubric. **Outcome:** - The teacher sends a POST request with the criterion name and scoring details. - The criterion is added to the existing rubric. - The rubric becomes more detailed and useful for structured evaluation.

Get Rubric List

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

{
  "count": 20,
  "pageSize": 10,
  "showing": "Page 1 of 2",
  "next": "{{base_url}}/rubrics/v1/rubric/?page=2",
  "previous": null,
  "data": [
    {
      "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"
    }
  ]
}