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}

Get Assignment

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

import requests

url = "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "detail": "Token has expired"
}

{
  "error": {
    "code": 404,
    "message": {
      "non_field_errors": [
        "Assignment not found"
      ]
    }
  }
}

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

Assignment retrieved successfully.

string<uuid>

Unique identifier for the assignment.

Example:

"2600413f-7c6e-46ef-8ea9-3e7b5834879f"

assignmentName

string

Name of the assignment.

Example:

"English Assignment"

status

integer

Status of the assignment (refer this doc to get the constants)

Example:

2

grade

string

Grade of the assignment.

Example:

"7"

marks

integer | null

Example:

10

section

string

Section of the assignment.

Example:

"A"

parentInstituteId

string

ID of the parent institute.

Example:

"100"

instituteId

string

ID of the institute.

Example:

"200"

courseId

string

ID of the course.

Example:

"300"

documents

object[]

List of documents associated with the assignment.

Show child attributes

createdAt

string<date-time>

Created date for the assignment.

Example:

"2025-04-06T09:03:42.099207Z"

modifiedAt

string<date-time>

Modified date of the assignment.

Example:

"2025-04-06T09:06:19.351379Z"

LIST - Assignment This API allows authenticated users to retrieve a paginated list of assignments along with associated metadata like total count, pagination links, and assignment details. **Key Notes:** - The response includes `count`, `pageSize`, `showing`, `next`, and `previous` to handle pagination. - The `data` field contains an array of assignment objects following the `UpdatedAssignmentResponse` schema. - Useful for dashboards or any view where a user needs to browse or manage multiple assignments. **Scenario: Fetching Assignments for Review** - A teacher wants to review all assignments created for Grade 7. - They send a GET request to this endpoint (optionally with query parameters for filtering/pagination). - The system responds with a paginated list of assignments and relevant navigation links.

Get Assignment

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

import requests

url = "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "detail": "Token has expired"
}

{
  "error": {
    "code": 404,
    "message": {
      "non_field_errors": [
        "Assignment not found"
      ]
    }
  }
}

Overview

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

GET - Assignment

Authorizations

Path Parameters

Response