class_dashboard

Get Student Sheet

Changed on

One student's marks, productions, and mastery profile for the period.

Both period semantics meet here: marks and productions are windowed, the mastery profile is cumulative from September.

get/teacher/classes/{class_id}/students/{student_id}/dashboard

Request

  • Base URL: https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.excellence-ai.com/teacher/classes/{class_id}/students/{student_id}/dashboard
  • Auth: OAuth 2 (password, token URL api/login)

Path parameters

class_idstring required
student_idstring required

Query parameters

periodstring nullable

Selected period: t1 / t2 / t3 / this_week / this_month / vacances_ete / school_year. An unrecognised value falls back to the full school year rather than erroring, so a stale bookmark still renders.

Response

Successful Response

student_idstring required
display_namestring required
class_namestring required
periodstring required
generalnumber nullable
by_typeobject
class_generalnumber nullable
class_by_typeobject
devoirs_doneinteger required
devoirs_assignedinteger required
controles_doneinteger required
controles_assignedinteger required
autonomy_exercisesinteger required
last_activitystring date-time nullable
has_radarboolean required
evaluated_chaptersinteger required
total_chaptersinteger required
weightsobject required

Changes

  • 0a41d91c9d20Revision changes
    • breaking

      the // response's property type changed from string to no type for status

    • info

      added subschema #1 subschema #2 to the // response property anyOf list for the response status

    • info

      removed the controle enum value from the // response property for the response status

    • info

      removed the cours enum value from the // response property for the response status

    • info

      removed the devoir enum value from the // response property for the response status

    • info

      removed the evaluation enum value from the // response property for the response status