Student Ping

Gets basic information about the logged in student and what access they have. This endpoint is also used for revalidating your session id (authentication token).

Authorization

Authorization<token>

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

In: header

Request Body

application/x-www-form-urlencodedOptional

include_datastring

Includes a new session id in the response meta

Default: "true"

curl -X POST "https://www.classcharts.com/apiv2student/ping" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d 'include_data=true'

Student information & session_id (if requested)

{
  "meta": {
    "version": "string",
    "session_id": "string"
  },
  "data": {
    "user": {
      "id": 0,
      "name": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string",
      "display_behaviour": true,
      "display_parent_behaviour": true,
      "display_homework": true,
      "display_rewards": true,
      "display_detentions": true,
      "display_report_cards": true,
      "display_classes": true,
      "display_announcements": true,
      "display_attendance": true,
      "display_attendance_type": "string",
      "display_attendance_percentage": true,
      "display_activity": true,
      "display_mental_health": true,
      "display_timetable": true,
      "is_disabled": true,
      "display_two_way_communications": true,
      "display_absences": true,
      "can_upload_attachments": true,
      "display_event_badges": true,
      "display_avatars": true,
      "display_concern_submission": true,
      "display_custom_fields": true,
      "pupil_concerns_help_text": "string",
      "allow_pupils_add_timetable_notes": true,
      "announcements_count": 0,
      "messages_count": 0,
      "pusher_channel_name": "string",
      "has_birthday": true,
      "has_new_survey": true,
      "survey_id": 0,
      "detention_alias_plural_uc": "string"
    }
  }
}

Student Ping

Authorization

Request Body

Response

TypeScript