Create a student action plan

POST

action-plan

k12

student

curl --request POST \
  --url https://api.crazygoldfish.com/action-plan/v1/k12/student \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ans_sheet_id": "8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b"
}
'

import requests

url = "https://api.crazygoldfish.com/action-plan/v1/k12/student"

payload = { "ans_sheet_id": "8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b" }
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({ans_sheet_id: '8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b'})
};

fetch('https://api.crazygoldfish.com/action-plan/v1/k12/student', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "detail": [
    {
      "id": "8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b",
      "msg": "Student action plan initiated successfully."
    }
  ]
}

Step 3 of 4 in Create action plans. This call starts a background job and returns the ans_sheet_id you sent.

Rules

Evaluate the answer sheet first. The plan is built from the answers where the student scored less than the question’s full marks, the feedback the evaluation left on them, and the questions the student got fully right. See Get scores for review.
The field is ans_sheet_id. Send it as JSON: {"ans_sheet_id": "..."}. The GET call takes the same ID under the same name.
One call covers one student. Loop over the exam’s answer sheets to cover a class.
A question the student was allowed to skip is not held against them. That covers an either/or alternative inside a question, and a section that says “answer any 8 of 12”.
The plan is written to the student, in the language of the question paper.
You can call it again for the same answer sheet. Each call creates a new plan, and the GET call returns the newest one.

Statuses the job ends in

Read these from Get a student action plan.

`status`	Meaning
`In Progress`	The job is still running. This is the status the plan starts with.
`Completed`	The plan is ready
`Partial`	The plan is ready, but one or more questions are missing from `questions`. Use it as it is, or start the plan again.
`Failed`	The plan could not be written. `action_plan` holds a single entry with an `error`.

A student plan usually takes under a minute.

Next step

Get a student action plan

Poll until status is Completed or Partial, or wait for the student_action_plan webhook.

Authorizations

Authorization

string

header

required

Access token from Get an access token.

Body

application/json

ans_sheet_id

string<uuid>

required

The evaluated answer sheet to analyze. The GET call takes the same ID under the same name.

Response

The job is queued. id is the ans_sheet_id you sent, not a new ID.

detail

object[]

Show child attributes

Create a student action plan

curl --request POST \
  --url https://api.crazygoldfish.com/action-plan/v1/k12/student \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ans_sheet_id": "8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b"
}
'

import requests

url = "https://api.crazygoldfish.com/action-plan/v1/k12/student"

payload = { "ans_sheet_id": "8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b" }
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({ans_sheet_id: '8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b'})
};

fetch('https://api.crazygoldfish.com/action-plan/v1/k12/student', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "detail": [
    {
      "id": "8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b",
      "msg": "Student action plan initiated successfully."
    }
  ]
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Create a student action plan

Rules

Statuses the job ends in

Next step

Get a student action plan

Authorizations

Body

Response

​Rules

​Statuses the job ends in

​Next step

Get a student action plan

Authorizations

Body

Response

Rules

Statuses the job ends in

Next step