PATCH - Update API

This is a generic API that allows you to update various components of an evaluation platform:

You can update the question text to reflect any changes or corrections.
The marking scheme can be modified to adjust the scoring criteria.
Model answer step marking can be updated to ensure accurate evaluation.
Additionally, you can update the student evaluated answer marking for consistency

Scenario: Updating Question Text for Clarity or Correction:

Clarifying or Correcting Question Text:
- During the evaluation process, an evaluator identifies an ambiguous or incorrect question. The Generic Update API allows updating the question text to make it clearer or correct any inaccuracies.
- Outcome:
  - The question text is updated, ensuring consistency across the platform and more accurate evaluation for students.

Scenario: Adjusting the Marking Scheme for a Specific Question:

Modifying the Marking Scheme:
- An evaluator reviews a question and decides to adjust the marking scheme, either by changing the total marks, modifying the breakdown, or adding new criteria.
- Outcome:
  - The marking scheme is updated, ensuring fairness and alignment with evaluation criteria.

Scenario: Updating Model Answer’s Step Marking:

Modifying Step-Wise Marking:
- After reviewing the model answer, the evaluator notices the step marking needs to be adjusted for clarity or accuracy. The Generic Update API is used to modify how marks are distributed across different steps.
- Outcome:
  - The step marking is updated, impacting how student answers are evaluated and ensuring accurate scoring.

Scenario: Correcting Student Answer Evaluation Marking:

Correcting Mistakes in Evaluation:
- After reviewing a student’s answer, an error is discovered in the evaluation, such as incorrect marking or wrong application of the model answer’s step-wise evaluation.
- Outcome:
  - The student’s evaluated answer is corrected, ensuring that the final score accurately reflects the correct evaluation based on the model answer.

PATCH

evaluation-platform

exam

{examId}

update

Update Evaluation

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/update/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
[
  {
    "entity": "modelAnswer",
    "id": "a17cd91d-55d3-46bb-a544-9f38ab2e027f",
    "text": "sdsdf",
    "stepMarking": [
      {
        "marksplit": 1,
        "step_wise_answer": "b"
      }
    ]
  },
  {
    "entity": "question",
    "id": "2f35d316-ed4e-430f-90e1-28ac133219f6",
    "text": "Titles adopted by the ruler-Devanampiya, often translated as 'beloved of the gods' and Piyadassi, or 'pleasant to behold'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta"
  }
]
EOF

import requests

url = "https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/update/"

payload = [
    {
        "entity": "modelAnswer",
        "id": "a17cd91d-55d3-46bb-a544-9f38ab2e027f",
        "text": "sdsdf",
        "stepMarking": [
            {
                "marksplit": 1,
                "step_wise_answer": "b"
            }
        ]
    },
    {
        "entity": "question",
        "id": "2f35d316-ed4e-430f-90e1-28ac133219f6",
        "text": "Titles adopted by the ruler-Devanampiya, often translated as 'beloved of the gods' and Piyadassi, or 'pleasant to behold'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta"
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      entity: 'modelAnswer',
      id: 'a17cd91d-55d3-46bb-a544-9f38ab2e027f',
      text: 'sdsdf',
      stepMarking: [{marksplit: 1, step_wise_answer: 'b'}]
    },
    {
      entity: 'question',
      id: '2f35d316-ed4e-430f-90e1-28ac133219f6',
      text: 'Titles adopted by the ruler-Devanampiya, often translated as \'beloved of the gods\' and Piyadassi, or \'pleasant to behold\'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta'
    }
  ])
};

fetch('https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/update/', 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/evaluation-platform/v1/exam/{examId}/update/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'entity' => 'modelAnswer',
        'id' => 'a17cd91d-55d3-46bb-a544-9f38ab2e027f',
        'text' => 'sdsdf',
        'stepMarking' => [
                [
                                'marksplit' => 1,
                                'step_wise_answer' => 'b'
                ]
        ]
    ],
    [
        'entity' => 'question',
        'id' => '2f35d316-ed4e-430f-90e1-28ac133219f6',
        'text' => 'Titles adopted by the ruler-Devanampiya, often translated as \'beloved of the gods\' and Piyadassi, or \'pleasant to behold\'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta'
    ]
  ]),
  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/evaluation-platform/v1/exam/{examId}/update/"

	payload := strings.NewReader("[\n  {\n    \"entity\": \"modelAnswer\",\n    \"id\": \"a17cd91d-55d3-46bb-a544-9f38ab2e027f\",\n    \"text\": \"sdsdf\",\n    \"stepMarking\": [\n      {\n        \"marksplit\": 1,\n        \"step_wise_answer\": \"b\"\n      }\n    ]\n  },\n  {\n    \"entity\": \"question\",\n    \"id\": \"2f35d316-ed4e-430f-90e1-28ac133219f6\",\n    \"text\": \"Titles adopted by the ruler-Devanampiya, often translated as 'beloved of the gods' and Piyadassi, or 'pleasant to behold'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta\"\n  }\n]")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/update/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"entity\": \"modelAnswer\",\n    \"id\": \"a17cd91d-55d3-46bb-a544-9f38ab2e027f\",\n    \"text\": \"sdsdf\",\n    \"stepMarking\": [\n      {\n        \"marksplit\": 1,\n        \"step_wise_answer\": \"b\"\n      }\n    ]\n  },\n  {\n    \"entity\": \"question\",\n    \"id\": \"2f35d316-ed4e-430f-90e1-28ac133219f6\",\n    \"text\": \"Titles adopted by the ruler-Devanampiya, often translated as 'beloved of the gods' and Piyadassi, or 'pleasant to behold'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/update/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"entity\": \"modelAnswer\",\n    \"id\": \"a17cd91d-55d3-46bb-a544-9f38ab2e027f\",\n    \"text\": \"sdsdf\",\n    \"stepMarking\": [\n      {\n        \"marksplit\": 1,\n        \"step_wise_answer\": \"b\"\n      }\n    ]\n  },\n  {\n    \"entity\": \"question\",\n    \"id\": \"2f35d316-ed4e-430f-90e1-28ac133219f6\",\n    \"text\": \"Titles adopted by the ruler-Devanampiya, often translated as 'beloved of the gods' and Piyadassi, or 'pleasant to behold'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta\"\n  }\n]"

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

{
  "status": "Success",
  "message": "Data updated successfully"
}

{
  "error": {
    "code": 400,
    "message": {
      "entity": [
        "Invalid entity: The provided entity is not valid."
      ]
    }
  }
}

{
  "detail": "Token has expired"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

examId

string

required

Body

application/json

Request payload containing a list of entities, including model answers and questions.

entity

string

required

Type of entity (e.g., modelAnswer or question).

Example:

"modelAnswer"

string<uuid>

required

Unique identifier for the entity.

Example:

"a17cd91d-55d3-46bb-a544-9f38ab2e027f"

text

string

required

The textual content of the entity.

Example:

"sdsdf"

stepMarking

object[]

List of step-wise marking details (only applicable to modelAnswer entities).

Show child attributes

Response

Successful operation response indicating the data was updated successfully.

status

string

Indicates the status of the operation.

Example:

"Success"

message

string

Provides additional details about the operation result.

Example:

"Data updated successfully"

POST - Embeddable UI Link The Embeddable UI API allows platforms to generate a unique embeddable link for a pre-configured user interface. This UI enables users to upload handwritten answer sheets, view model answers, and receive detailed evaluations. The API simplifies the integration process, making it easy for platforms to offer this functionality as part of their workflows. **Scenario: Integrating the Embeddable UI into an Educational Platform:** 1. **Platform Integration:** - An educational platform wants to provide users with the ability to upload handwritten answer sheets, view model answers, and receive evaluations. Instead of building a custom interface, they use the Embeddable UI API to generate a unique embeddable link. - The link is pre-configured to provide: - Upload options for handwritten answer sheets in PDF or image format. - A view to compare their answers with model answers. - Detailed evaluations of their answers based on the model answers and marking scheme. 2. **Outcome:** - The platform seamlessly embeds the UI into their system, allowing users to interact with the grading and evaluation features without navigating away from the main educational platform.

Update Evaluation

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/update/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
[
  {
    "entity": "modelAnswer",
    "id": "a17cd91d-55d3-46bb-a544-9f38ab2e027f",
    "text": "sdsdf",
    "stepMarking": [
      {
        "marksplit": 1,
        "step_wise_answer": "b"
      }
    ]
  },
  {
    "entity": "question",
    "id": "2f35d316-ed4e-430f-90e1-28ac133219f6",
    "text": "Titles adopted by the ruler-Devanampiya, often translated as 'beloved of the gods' and Piyadassi, or 'pleasant to behold'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta"
  }
]
EOF

import requests

url = "https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/update/"

payload = [
    {
        "entity": "modelAnswer",
        "id": "a17cd91d-55d3-46bb-a544-9f38ab2e027f",
        "text": "sdsdf",
        "stepMarking": [
            {
                "marksplit": 1,
                "step_wise_answer": "b"
            }
        ]
    },
    {
        "entity": "question",
        "id": "2f35d316-ed4e-430f-90e1-28ac133219f6",
        "text": "Titles adopted by the ruler-Devanampiya, often translated as 'beloved of the gods' and Piyadassi, or 'pleasant to behold'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta"
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      entity: 'modelAnswer',
      id: 'a17cd91d-55d3-46bb-a544-9f38ab2e027f',
      text: 'sdsdf',
      stepMarking: [{marksplit: 1, step_wise_answer: 'b'}]
    },
    {
      entity: 'question',
      id: '2f35d316-ed4e-430f-90e1-28ac133219f6',
      text: 'Titles adopted by the ruler-Devanampiya, often translated as \'beloved of the gods\' and Piyadassi, or \'pleasant to behold\'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta'
    }
  ])
};

fetch('https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/update/', 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/evaluation-platform/v1/exam/{examId}/update/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'entity' => 'modelAnswer',
        'id' => 'a17cd91d-55d3-46bb-a544-9f38ab2e027f',
        'text' => 'sdsdf',
        'stepMarking' => [
                [
                                'marksplit' => 1,
                                'step_wise_answer' => 'b'
                ]
        ]
    ],
    [
        'entity' => 'question',
        'id' => '2f35d316-ed4e-430f-90e1-28ac133219f6',
        'text' => 'Titles adopted by the ruler-Devanampiya, often translated as \'beloved of the gods\' and Piyadassi, or \'pleasant to behold\'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta'
    ]
  ]),
  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/evaluation-platform/v1/exam/{examId}/update/"

	payload := strings.NewReader("[\n  {\n    \"entity\": \"modelAnswer\",\n    \"id\": \"a17cd91d-55d3-46bb-a544-9f38ab2e027f\",\n    \"text\": \"sdsdf\",\n    \"stepMarking\": [\n      {\n        \"marksplit\": 1,\n        \"step_wise_answer\": \"b\"\n      }\n    ]\n  },\n  {\n    \"entity\": \"question\",\n    \"id\": \"2f35d316-ed4e-430f-90e1-28ac133219f6\",\n    \"text\": \"Titles adopted by the ruler-Devanampiya, often translated as 'beloved of the gods' and Piyadassi, or 'pleasant to behold'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta\"\n  }\n]")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/update/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"entity\": \"modelAnswer\",\n    \"id\": \"a17cd91d-55d3-46bb-a544-9f38ab2e027f\",\n    \"text\": \"sdsdf\",\n    \"stepMarking\": [\n      {\n        \"marksplit\": 1,\n        \"step_wise_answer\": \"b\"\n      }\n    ]\n  },\n  {\n    \"entity\": \"question\",\n    \"id\": \"2f35d316-ed4e-430f-90e1-28ac133219f6\",\n    \"text\": \"Titles adopted by the ruler-Devanampiya, often translated as 'beloved of the gods' and Piyadassi, or 'pleasant to behold'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/update/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"entity\": \"modelAnswer\",\n    \"id\": \"a17cd91d-55d3-46bb-a544-9f38ab2e027f\",\n    \"text\": \"sdsdf\",\n    \"stepMarking\": [\n      {\n        \"marksplit\": 1,\n        \"step_wise_answer\": \"b\"\n      }\n    ]\n  },\n  {\n    \"entity\": \"question\",\n    \"id\": \"2f35d316-ed4e-430f-90e1-28ac133219f6\",\n    \"text\": \"Titles adopted by the ruler-Devanampiya, often translated as 'beloved of the gods' and Piyadassi, or 'pleasant to behold'. A. King Harshavardhan B. King Ashoka C. King Samudragupta D. King Chandragupta\"\n  }\n]"

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

{
  "status": "Success",
  "message": "Data updated successfully"
}

{
  "error": {
    "code": 400,
    "message": {
      "entity": [
        "Invalid entity: The provided entity is not valid."
      ]
    }
  }
}

{
  "detail": "Token has expired"
}

Overview

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

PATCH - Update API

Authorizations

Path Parameters

Body

Response