Skip to main content
POST
/
v1
/
ielts
/
evaluation
Submit Evaluation Request
curl --request POST \
  --url https://api-staging.crazygoldfish.com/v1/ielts/evaluation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'accept: <accept>' \
  --data '{
  "client_id": "12345ABC",
  "institution_id": "67890XYZ",
  "teacher_id": "98765LMN",
  "parent_id": "54321PQR",
  "student_id": "11223STU",
  "exam_type": "AC",
  "student_name": "John Doe",
  "image_urls": [
    "http://example.com/image1.jpg",
    "http://example.com/image2.jpg"
  ],
  "evaluation_text": [
    {
      "question_id": "q1",
      "question_number": "1",
      "question_section": "writing",
      "question_type": "IE-AC-W-01",
      "question_text": "Summarize the points made in the lecture.",
      "question_multimedia_url": "<string>",
      "answer_text": "The lecture discusses the various impacts of climate change.",
      "answer_multimedia_url": "<string>",
      "custom_rubric_id": "1234"
    }
  ]
}'
{
  "status": "200",
  "message": "Evaluation request submitted successfully",
  "data": [
    {
      "evaluation_id": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
accept
enum<string>
default:application/json
required
Available options:
application/json

Body

application/json
​
client_id
string
required

Unique identifier assigned to the client accessing the API.

Example:

"12345ABC"

​
student_id
string
required

Identifies the specific student for whom the evaluation is being requested.

Example:

"11223STU"

​
exam_type
enum<string>
required

Type of IELTS exam (AC for Academic, GT for General Training).

Available options:
AC,
GT
Example:

"AC"

​
student_name
string
required

Name of the student for whom the evaluation is being requested.

Example:

"John Doe"

​
evaluation_text
object[]
required

List of evaluation questions and answers.

​
institution_id
string

Unique identifier of the institution (optional).

Example:

"67890XYZ"

​
teacher_id
string

Identifier of the teacher (optional).

Example:

"98765LMN"

​
parent_id
string

Unique identifier of the parent associated with the student (optional).

Example:

"54321PQR"

​
image_urls
string[]

List of URLs pointing to the images of the evaluated work (optional).

Example:
[
  "http://example.com/image1.jpg",
  "http://example.com/image2.jpg"
]

Response

Evaluation request submitted successfully

​
status
string
Example:

"200"

​
message
string
Example:

"Evaluation request submitted successfully"

​
data
object[]