Skip to main content
POST
/
evaluation-platform
/
v1
/
embeddable-ui-link
Get Embeddable UI Link
curl --request POST \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/embeddable-ui-link/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "examId": "4340132f-50fa-4877-9ffa-e9b7ee59d51f",
  "studentId": "2017009807",
  "instituteId": "98765",
  "teacherId": "54321",
  "studentName": "John Doe",
  "parentId": "11223"
}
'
{
  "link": "https://k12.crazygoldfish.com/evaluate/4340132f-50fa-4877-9ffa-e9b7ee59d51f/answers/f5f2576f-1e3a-4869-88ae-a2c6cd2b9eab",
  "studentId": "2017009807",
  "instituteId": "98765",
  "teacherId": "54321",
  "studentName": "John Doe",
  "parentId": "11223"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
examId
string
required

Unique identifier of the exam

Example:

"4340132f-50fa-4877-9ffa-e9b7ee59d51f"

​
studentId
string
required

Unique identifier of the student

Example:

"2017009807"

​
instituteId
string | null

Unique identifier of the institution

Example:

"98765"

​
teacherId
string | null

Unique identifier of the teacher

Example:

"54321"

​
studentName
string | null

Name of the student

Example:

"John Doe"

​
parentId
string | null

Unique identifier of the parent

Example:

"11223"

Response

Answer sheet created successfully

​
link
string

Link to the embeddable UI

Example:

"https://k12.crazygoldfish.com/evaluate/4340132f-50fa-4877-9ffa-e9b7ee59d51f/answers/f5f2576f-1e3a-4869-88ae-a2c6cd2b9eab"

​
studentId
string

Unique identifier of the student

Example:

"2017009807"

​
instituteId
string

Unique identifier of the institution

Example:

"98765"

​
teacherId
string

Unique identifier of the teacher

Example:

"54321"

​
studentName
string

Name of the student

Example:

"John Doe"

​
parentId
string

Unique identifier of the parent

Example:

"11223"