GET - Assignment

This API allows authenticated users to retrieve the details of a specific assignment by providing its unique ID.

Key Notes:

id (required in path): The unique identifier of the assignment to be retrieved.
Returns all metadata related to the assignment including its name, institute details, grade, section, and document status.

Scenario: Viewing a Previously Created Assignment

A teacher wants to verify the information of an already created assignment.
They send a GET request with the assignment’s ID.
The system returns all associated details, including whether documents were uploaded and if extraction has begun.

GET

assignment-evaluation

assignment

{id}

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

{
  "id": "2600413f-7c6e-46ef-8ea9-3e7b5834879f",
  "assignmentName": "English Assignment",
  "status": 2,
  "grade": "7",
  "marks": 10,
  "section": "A",
  "parentInstituteId": "100",
  "instituteId": "200",
  "courseId": "300",
  "documents": [
    {
      "id": "bec0d0bf-fff6-40de-9750-65f5dcaf470d",
      "status": 1,
      "pageNo": 1,
      "uploadTime": "2025-04-06T09:04:11.716434Z",
      "url": "https://cgfblob.blob.core.windows.net/documents/assignment-evaluation/olfactory_imagery_HW_PDF_2_questions_1_H7dPCAd.pdf",
      "fileType": 1
    }
  ],
  "createdAt": "2025-04-06T09:03:42.099207Z",
  "modifiedAt": "2025-04-06T09:06:19.351379Z"
}

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 of the assignment

Response

200

application/json

Assignment retrieved successfully.

The response is of type object.

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

{
  "id": "2600413f-7c6e-46ef-8ea9-3e7b5834879f",
  "assignmentName": "English Assignment",
  "status": 2,
  "grade": "7",
  "marks": 10,
  "section": "A",
  "parentInstituteId": "100",
  "instituteId": "200",
  "courseId": "300",
  "documents": [
    {
      "id": "bec0d0bf-fff6-40de-9750-65f5dcaf470d",
      "status": 1,
      "pageNo": 1,
      "uploadTime": "2025-04-06T09:04:11.716434Z",
      "url": "https://cgfblob.blob.core.windows.net/documents/assignment-evaluation/olfactory_imagery_HW_PDF_2_questions_1_H7dPCAd.pdf",
      "fileType": 1
    }
  ],
  "createdAt": "2025-04-06T09:03:42.099207Z",
  "modifiedAt": "2025-04-06T09:06:19.351379Z"
}

GET - Assignment

This API allows authenticated users to retrieve the details of a specific assignment by providing its unique ID.

Key Notes:

id (required in path): The unique identifier of the assignment to be retrieved.
Returns all metadata related to the assignment including its name, institute details, grade, section, and document status.

Scenario: Viewing a Previously Created Assignment

A teacher wants to verify the information of an already created assignment.
They send a GET request with the assignment’s ID.
The system returns all associated details, including whether documents were uploaded and if extraction has begun.

GET

assignment-evaluation

assignment

{id}

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

{
  "id": "2600413f-7c6e-46ef-8ea9-3e7b5834879f",
  "assignmentName": "English Assignment",
  "status": 2,
  "grade": "7",
  "marks": 10,
  "section": "A",
  "parentInstituteId": "100",
  "instituteId": "200",
  "courseId": "300",
  "documents": [
    {
      "id": "bec0d0bf-fff6-40de-9750-65f5dcaf470d",
      "status": 1,
      "pageNo": 1,
      "uploadTime": "2025-04-06T09:04:11.716434Z",
      "url": "https://cgfblob.blob.core.windows.net/documents/assignment-evaluation/olfactory_imagery_HW_PDF_2_questions_1_H7dPCAd.pdf",
      "fileType": 1
    }
  ],
  "createdAt": "2025-04-06T09:03:42.099207Z",
  "modifiedAt": "2025-04-06T09:06:19.351379Z"
}

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 of the assignment

Response

200

application/json

Assignment retrieved successfully.

The response is of type object.

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

{
  "id": "2600413f-7c6e-46ef-8ea9-3e7b5834879f",
  "assignmentName": "English Assignment",
  "status": 2,
  "grade": "7",
  "marks": 10,
  "section": "A",
  "parentInstituteId": "100",
  "instituteId": "200",
  "courseId": "300",
  "documents": [
    {
      "id": "bec0d0bf-fff6-40de-9750-65f5dcaf470d",
      "status": 1,
      "pageNo": 1,
      "uploadTime": "2025-04-06T09:04:11.716434Z",
      "url": "https://cgfblob.blob.core.windows.net/documents/assignment-evaluation/olfactory_imagery_HW_PDF_2_questions_1_H7dPCAd.pdf",
      "fileType": 1
    }
  ],
  "createdAt": "2025-04-06T09:03:42.099207Z",
  "modifiedAt": "2025-04-06T09:06:19.351379Z"
}

GET - Assignment

Authorizations

Path Parameters

Response

Authentication

K12

Assessment Rubrics

Standardized Language Exams

GET - Assignment

Authorizations

Path Parameters

Response