PATCH - Assignment
This API allows authenticated users to update an existing assignment by modifying its details or uploading assignment documents.
Key Notes:
id(required in path): Unique identifier of the assignment to be updated.- Request body accepts
multipart/form-datafor file uploads. - You can update metadata like
assignmentName,grade,section, or upload a document file using thedocumentsfield. - Use the
isFinalflag to signal that the document upload is complete, which will trigger document extraction.
Scenario: Uploading the Final Document
- A teacher updates the assignment by uploading the final assignment PDF and setting
isFinaltotrue. - This flags the system to begin extracting content from the uploaded file.
If both
documents and isFinal are provided in the same request, a validation error is returned. Use either documents to upload, or isFinal to trigger extraction — not both together. PATCH
/
assignment-evaluation
/
v1
/
assignment
/
{id}
/
Update Assignment
curl --request PATCH \
--url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'assignmentName=English Assignment' \
--form parentInstituteId=100 \
--form instituteId=200 \
--form courseId=300 \
--form grade=7 \
--form section=A \
--form documents='@example-file' \
--form isFinal=trueimport requests
url = "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/"
files = { "documents": ("example-file", open("example-file", "rb")) }
payload = {
"assignmentName": "English Assignment",
"parentInstituteId": "100",
"instituteId": "200",
"courseId": "300",
"grade": "7",
"section": "A",
"isFinal": "true"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.patch(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('assignmentName', 'English Assignment');
form.append('parentInstituteId', '100');
form.append('instituteId', '200');
form.append('courseId', '300');
form.append('grade', '7');
form.append('section', 'A');
form.append('documents', '<string>');
form.append('isFinal', 'true');
const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
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 => "PATCH",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"assignmentName\"\r\n\r\nEnglish Assignment\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parentInstituteId\"\r\n\r\n100\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instituteId\"\r\n\r\n200\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"courseId\"\r\n\r\n300\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"grade\"\r\n\r\n7\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"section\"\r\n\r\nA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"assignmentName\"\r\n\r\nEnglish Assignment\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parentInstituteId\"\r\n\r\n100\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instituteId\"\r\n\r\n200\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"courseId\"\r\n\r\n300\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"grade\"\r\n\r\n7\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"section\"\r\n\r\nA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"assignmentName\"\r\n\r\nEnglish Assignment\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parentInstituteId\"\r\n\r\n100\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instituteId\"\r\n\r\n200\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"courseId\"\r\n\r\n300\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"grade\"\r\n\r\n7\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"section\"\r\n\r\nA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
.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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"assignmentName\"\r\n\r\nEnglish Assignment\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parentInstituteId\"\r\n\r\n100\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instituteId\"\r\n\r\n200\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"courseId\"\r\n\r\n300\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"grade\"\r\n\r\n7\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"section\"\r\n\r\nA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001--"
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"
}{
"error": {
"code": 400,
"message": {
"non_field_errors": [
"Only one of documents or isFinal can be processed at a time"
]
}
}
}{
"detail": "Token has expired"
}{
"error": {
"code": 404,
"message": {
"non_field_errors": [
"Assignment not found"
]
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the assignment
Body
multipart/form-data
Name of the assignment
Example:
"English Assignment"
ID of the parent institute
Example:
"100"
ID of the institute
Example:
"200"
ID of the course
Example:
"300"
Grade of the assignment
Example:
"7"
Section of the assignment
Example:
"A"
The assignment file to be uploaded.
After successfully uploaded the assignment then set isFinal as true it will start extracting your document.
Example:
true
Response
Assignment updated successfully
Unique identifier for the assignment.
Example:
"2600413f-7c6e-46ef-8ea9-3e7b5834879f"
Name of the assignment.
Example:
"English Assignment"
Status of the assignment (refer this doc to get the constants)
Example:
2
Grade of the assignment.
Example:
"7"
Example:
10
Section of the assignment.
Example:
"A"
ID of the parent institute.
Example:
"100"
ID of the institute.
Example:
"200"
ID of the course.
Example:
"300"
List of documents associated with the assignment.
Show child attributes
Show child attributes
Created date for the assignment.
Example:
"2025-04-06T09:03:42.099207Z"
Modified date of the assignment.
Example:
"2025-04-06T09:06:19.351379Z"
Was this page helpful?
⌘I
Update Assignment
curl --request PATCH \
--url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'assignmentName=English Assignment' \
--form parentInstituteId=100 \
--form instituteId=200 \
--form courseId=300 \
--form grade=7 \
--form section=A \
--form documents='@example-file' \
--form isFinal=trueimport requests
url = "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/"
files = { "documents": ("example-file", open("example-file", "rb")) }
payload = {
"assignmentName": "English Assignment",
"parentInstituteId": "100",
"instituteId": "200",
"courseId": "300",
"grade": "7",
"section": "A",
"isFinal": "true"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.patch(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('assignmentName', 'English Assignment');
form.append('parentInstituteId', '100');
form.append('instituteId', '200');
form.append('courseId', '300');
form.append('grade', '7');
form.append('section', 'A');
form.append('documents', '<string>');
form.append('isFinal', 'true');
const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
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 => "PATCH",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"assignmentName\"\r\n\r\nEnglish Assignment\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parentInstituteId\"\r\n\r\n100\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instituteId\"\r\n\r\n200\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"courseId\"\r\n\r\n300\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"grade\"\r\n\r\n7\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"section\"\r\n\r\nA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"assignmentName\"\r\n\r\nEnglish Assignment\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parentInstituteId\"\r\n\r\n100\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instituteId\"\r\n\r\n200\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"courseId\"\r\n\r\n300\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"grade\"\r\n\r\n7\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"section\"\r\n\r\nA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"assignmentName\"\r\n\r\nEnglish Assignment\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parentInstituteId\"\r\n\r\n100\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instituteId\"\r\n\r\n200\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"courseId\"\r\n\r\n300\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"grade\"\r\n\r\n7\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"section\"\r\n\r\nA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
.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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"assignmentName\"\r\n\r\nEnglish Assignment\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parentInstituteId\"\r\n\r\n100\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instituteId\"\r\n\r\n200\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"courseId\"\r\n\r\n300\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"grade\"\r\n\r\n7\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"section\"\r\n\r\nA\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"documents\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"isFinal\"\r\n\r\ntrue\r\n-----011000010111000001101001--"
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"
}{
"error": {
"code": 400,
"message": {
"non_field_errors": [
"Only one of documents or isFinal can be processed at a time"
]
}
}
}{
"detail": "Token has expired"
}{
"error": {
"code": 404,
"message": {
"non_field_errors": [
"Assignment not found"
]
}
}
}