POST - Student Assignment Sheet

The API allows clients to create a new assignment sheet for a specific student in an assignment. It associates the student’s ID with an assignment sheet and returns the unique ID for the assignment sheet. The assignment sheet can later be updated with documents (e.g., scanned PDFs or images).

Scenarios:

Creating a New assignment Sheet for a Student:
- A teacher provides the student’s ID to create a new assignment sheet.
- Outcome:
  - The API generates a unique assignment sheet ID linked to the student.
  - This ID is used for future reference and document uploads.
Associating Documents with the Created assignment Sheet:
- After scanning the student’s handwritten assignment sheet, the teacher uploads a PDF or JPEG images using the unique assignment sheet ID.
- Outcome:
  - The scanned document is associated with the student’s assignment sheet, enabling it to be evaluated or graded in subsequent steps.

POST

assignment-evaluation

assignment

{id}

answer-sheet

Upload Assignment Answer Sheet

curl --request POST \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "studentId": "12345",
  "name": "John Doe",
  "batchId": "batch_1",
  "sessionId": "session_1",
  "teacherId": "teacher_1"
}
'

import requests

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

payload = {
    "studentId": "12345",
    "name": "John Doe",
    "batchId": "batch_1",
    "sessionId": "session_1",
    "teacherId": "teacher_1"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    studentId: '12345',
    name: 'John Doe',
    batchId: 'batch_1',
    sessionId: 'session_1',
    teacherId: 'teacher_1'
  })
};

fetch('https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/', 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}/answer-sheet/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'studentId' => '12345',
    'name' => 'John Doe',
    'batchId' => 'batch_1',
    'sessionId' => 'session_1',
    'teacherId' => 'teacher_1'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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}/answer-sheet/"

	payload := strings.NewReader("{\n  \"studentId\": \"12345\",\n  \"name\": \"John Doe\",\n  \"batchId\": \"batch_1\",\n  \"sessionId\": \"session_1\",\n  \"teacherId\": \"teacher_1\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"studentId\": \"12345\",\n  \"name\": \"John Doe\",\n  \"batchId\": \"batch_1\",\n  \"sessionId\": \"session_1\",\n  \"teacherId\": \"teacher_1\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"studentId\": \"12345\",\n  \"name\": \"John Doe\",\n  \"batchId\": \"batch_1\",\n  \"sessionId\": \"session_1\",\n  \"teacherId\": \"teacher_1\"\n}"

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

{
  "id": "57387c68-0706-4a9d-834a-237b6b63cb5d",
  "status": 0,
  "studentId": "12345",
  "name": "John Doe",
  "batchId": "batch_1",
  "sessionId": "session_1",
  "documents": []
}

{
  "error": {
    "code": 400,
    "message": {
      "non_field_errors": [
        "Assignment is not extracted yet"
      ]
    }
  }
}

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

Body

application/json

studentId

string

required

Unique identifier of the student.

Example:

"12345"

name

string

required

Name of the student.

Example:

"John Doe"

batchId

string | null

Unique identifier of the batch.

Example:

"batch_1"

sessionId

string | null

Unique identifier of the session.

Example:

"session_1"

teacherId

string | null

Unique identifier of the teacher.

Example:

"teacher_1"

Response

Answer sheet uploaded successfully.

string<uuid>

Unique identifier for the answer sheet.

Example:

"57387c68-0706-4a9d-834a-237b6b63cb5d"

status

integer

Status of the answer sheet.

Example:

0

studentId

string

Unique identifier of the student.

Example:

"12345"

name

string

Name of the student.

Example:

"John Doe"

batchId

string | null

Unique identifier of the batch.

Example:

"batch_1"

sessionId

string | null

Unique identifier of the session.

Example:

"session_1"

documents

object[]

List of documents associated with the answer sheet.

Example:

[]

Upload Assignment Answer Sheet

curl --request POST \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "studentId": "12345",
  "name": "John Doe",
  "batchId": "batch_1",
  "sessionId": "session_1",
  "teacherId": "teacher_1"
}
'

import requests

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

payload = {
    "studentId": "12345",
    "name": "John Doe",
    "batchId": "batch_1",
    "sessionId": "session_1",
    "teacherId": "teacher_1"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    studentId: '12345',
    name: 'John Doe',
    batchId: 'batch_1',
    sessionId: 'session_1',
    teacherId: 'teacher_1'
  })
};

fetch('https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/', 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}/answer-sheet/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'studentId' => '12345',
    'name' => 'John Doe',
    'batchId' => 'batch_1',
    'sessionId' => 'session_1',
    'teacherId' => 'teacher_1'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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}/answer-sheet/"

	payload := strings.NewReader("{\n  \"studentId\": \"12345\",\n  \"name\": \"John Doe\",\n  \"batchId\": \"batch_1\",\n  \"sessionId\": \"session_1\",\n  \"teacherId\": \"teacher_1\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"studentId\": \"12345\",\n  \"name\": \"John Doe\",\n  \"batchId\": \"batch_1\",\n  \"sessionId\": \"session_1\",\n  \"teacherId\": \"teacher_1\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"studentId\": \"12345\",\n  \"name\": \"John Doe\",\n  \"batchId\": \"batch_1\",\n  \"sessionId\": \"session_1\",\n  \"teacherId\": \"teacher_1\"\n}"

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

{
  "id": "57387c68-0706-4a9d-834a-237b6b63cb5d",
  "status": 0,
  "studentId": "12345",
  "name": "John Doe",
  "batchId": "batch_1",
  "sessionId": "session_1",
  "documents": []
}

{
  "error": {
    "code": 400,
    "message": {
      "non_field_errors": [
        "Assignment is not extracted yet"
      ]
    }
  }
}

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

POST - Student Assignment Sheet

Authorizations

Path Parameters

Body

Response