Create an embeddable UI link

POST

evaluation-platform

embeddable-ui-link

curl --request POST \
  --url https://api.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "examId": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
  "studentId": "S-2043"
}
'

import requests

url = "https://api.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/"

payload = {
    "examId": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
    "studentId": "S-2043"
}
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({examId: 'd19e6868-98dd-4274-a2a5-4a616dd93ea7', studentId: 'S-2043'})
};

fetch('https://api.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "link": "https://k12.crazygoldfish.com/evaluate/d19e6868-98dd-4274-a2a5-4a616dd93ea7/answers/8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b",
  "studentId": "S-2043",
  "instituteId": "SCH-17",
  "teacherId": "T-1042",
  "studentName": "Aarav Sharma",
  "parentId": "P-9981"
}

This is the shortcut for step 5 of Evaluate an exam. One call creates the answer sheet and gives you a page to embed, so you do not have to build upload or review screens.

Rules

examId and studentId are both required. studentName, teacherId, instituteId, and parentId are optional.
The exam must exist. Anything else returns 400 Invalid exam ID.
Every call creates a new answer sheet. Call it once per student attempt and store the link, or you end up with empty sheets.
Unlike Create an exam answer sheet, this call does not check that the questions and answer key are extracted. Do that yourself before you hand the link to a student.

The new answer sheet’s ID is only inside link, as its last path segment. There is no id field in the response. Parse it out if you want to follow that sheet with the API:

https://k12.crazygoldfish.com/evaluate/<examId>/answers/<answerSheetId>

For what the page looks like and how to frame it, see Embeddable UI.

Authorizations

Authorization

string

header

required

Access token from Get an access token. A missing, invalid, or expired token returns 403.

Body

application/json

examId

string<uuid>

required

The exam to evaluate against.

studentId

string

required

Your student reference. Required.

instituteId

string

Your school or institute reference.

teacherId

string

Your teacher reference.

studentName

string

parentId

string

Your parent reference.

Response

The link and the references you sent. The new answer sheet's ID is the last segment of link, and it is not returned as a separate field.

link

string

The page to embed or send to the student. The last path segment is the ID of the answer sheet this call created, and it is the only place that ID appears.

studentId

string | null

instituteId

string | null

teacherId

string | null

studentName

string | null

parentId

string | null

Create an embeddable UI link

curl --request POST \
  --url https://api.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "examId": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
  "studentId": "S-2043"
}
'

import requests

url = "https://api.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/"

payload = {
    "examId": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
    "studentId": "S-2043"
}
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({examId: 'd19e6868-98dd-4274-a2a5-4a616dd93ea7', studentId: 'S-2043'})
};

fetch('https://api.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "link": "https://k12.crazygoldfish.com/evaluate/d19e6868-98dd-4274-a2a5-4a616dd93ea7/answers/8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b",
  "studentId": "S-2043",
  "instituteId": "SCH-17",
  "teacherId": "T-1042",
  "studentName": "Aarav Sharma",
  "parentId": "P-9981"
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Create an embeddable UI link

Rules

Authorizations

Body

Response

​Rules

Authorizations

Body

Response

Rules