PATCH - Rubric

This API allows updating an existing rubric by its unique ID. You can modify attributes such as the rubric name and description.

Key Notes:

Only the fields provided in the request body will be updated.
id must be a valid UUID of an existing rubric.
Authentication via Bearer Token is required.
If the rubric does not exist, a 404 error is returned.

Use Cases:

Rename a rubric after creation.
Add or update a description to provide more context.
Make iterative refinements before using the rubric for evaluations.

PATCH

rubrics

rubric

{id}

Update Rubric

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/rubrics/v1/rubric/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Science Rubric",
  "description": "A rubric for evaluating science 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.

Path Parameters

string

required

Unique identifier for the rubric.

Body

application/json

name

string

Name of the rubric

Example:

"Science Rubric"

description

string

Description of the rubric

Example:

"A rubric for evaluating science hand written assignment."

Response

Rubric updated 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

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.

Update Rubric

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/rubrics/v1/rubric/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Science Rubric",
  "description": "A rubric for evaluating science 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"
}