ClassCharts API Docs

List Activity

Lists up to 50 activity points

GET
/activity/{studentId}

Authorization

Authorization<token>

This is the session_id returned when logging in. It must be prefixed with Basic. e.g. Basic eW91IHNob3VsZCBzdGFyIHRoaXMgcmVwbyE=

In: header

Path Parameters

studentIdRequiredinteger

Query Parameters

fromstring
Format: "date"
tostring

This endpoint is meant for pagination so the response will not include up to this date (unless there is less than 50 points)

Format: "date"
last_idstring

This endpoint is meant for pagination so this field is used to start as a specific id onwards

curl -X GET "https://www.classcharts.com/apiv2student/activity/0?from=2019-08-24&to=2019-08-24&last_id=string" \
  -H "Authorization: <token>"

Array of activity points

{
  "data": [
    {
      "id": 0,
      "type": "detention",
      "polarity": "positive",
      "reason": "string",
      "score": 0,
      "timestamp": "string",
      "timestamp_custom_time": "string",
      "style": {
        "border_color": "string",
        "custom_class": "notice-color"
      },
      "pupil_name": "string",
      "lesson_name": "string",
      "teacher_name": "string",
      "room_name": "string",
      "note": "string",
      "_can_delete": true,
      "badges": "string",
      "detention_date": "string",
      "detention_time": "string",
      "detention_location": "string",
      "detention_type": "string"
    }
  ],
  "meta": {
    "start_date": "string",
    "end_date": "string",
    "last_id": "string",
    "step_size": "string",
    "detention_alias_uc": "string"
  },
  "success": 0
}

List Academic Reports GET

Get list of academic reports

List Announcements GET

Gets the student's announcements