Skip to main content
There is no parent action plan flow in the API. Nothing is generated for a parent, and nothing is sent to a family by CrazyGoldFish. The route below uses a student action plan, which is the only plan written in language a family can read.

​
What route is available today?

Three steps, and the last one belongs to your platform.
1

Mark the paper

The student’s answer sheet is evaluated first. Marking saves the marks for each answer and the feedback comments explaining what was wrong. Both are needed before any plan can be written. See Evaluate an exam.
2

Create a student action plan

Your platform sends the answer sheet ID and reads the plan back once it is ready. The plan contains a summary of the paper, what the student should do next, a skill focus, an encouraging tip, and the advice for each question where marks were lost.
3

Share what you choose to share

This step is entirely yours. The API returns text, so your platform decides which parts a family sees, in which screen or message, and after whose approval. Nothing happens automatically.

​
What the API does not do in this route

  • It does not rewrite a plan for a parent audience. The wording is addressed to the student.
  • It does not translate. Plans are written in English only.
  • It does not send anything. There is no email, SMS, or messaging in the service.
  • It does not decide who may read a plan. It returns the plan to the API user that created it, and the rest is your call. Note that a second API user on the same account will not get the plan back, so create it with the user that needs it.

​
Frequently asked questions

No. There is no parent request and no parent format. What you can do is show selected parts of the student plan.
No. A teacher action plan lists the student IDs of everyone who lost marks on a question, so it contains other children’s results. Treat it as staff information.
Register the student_action_plan webhook, and the service calls your URL when the work ends. You can also read the plan and check whether its status is still In Progress.
Not through the Action Plan API. Any conversation happens in your own product.

​
Next steps

Student action plan workflow

The flow this route depends on, step by step.

Developer guide

Create student and teacher action plans with the API, step by step.