Student Login

Logs in a student.

POST
/login

Request Body

application/x-www-form-urlencodedRequired
codeRequiredstring
rememberboolean
recaptcha-tokenRequiredstring
dobRequiredstring
Format: "date"
curl -X POST "https://www.classcharts.com/apiv2student/login" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d 'code=ABC123&remember=true&recaptcha-token=no-token-available&dob=2000-01-01'

Successful authentication request (not necessarily successful login)

{
  "success": 1,
  "data": {
    "id": 123,
    "name": "John Doe",
    "first_name": "John",
    "last_name": "Doe",
    "avatar_url": "https://example.com/avatar.jpg",
    "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_academic_reports": true,
    "display_attendance": true,
    "display_attendance_type": "detailed",
    "display_attendance_percentage": true,
    "display_activity": true,
    "display_mental_health": true,
    "display_mental_health_no_tracker": true,
    "display_timetable": true,
    "is_disabled": false,
    "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": "If you have any concerns, please talk to your teacher.",
    "allow_pupils_add_timetable_notes": true,
    "detention_alias_plural_uc": "Detentions"
  },
  "meta": {
    "session_id": "session_id_123"
  },
  "error": "Invalid code"
}