ClassCharts API Docs

List Homeworks

Gets the student's homeworks

GET
/homeworks/{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

display_datestring
Default: "issue_date"Value in: "issue_date" | "due_date"
fromstring
Format: "date"
tostring
Format: "date"
curl -X GET "https://www.classcharts.com/apiv2student/homeworks/0?display_date=issue_date&from=2019-08-24&to=2019-08-24" \
  -H "Authorization: <token>"

Array of homeworks

{
  "data": [
    {
      "lesson": "string",
      "subject": "string",
      "teacher": "string",
      "homework_type": "string",
      "id": 0,
      "title": "string",
      "meta_title": "string",
      "description": "string",
      "issue_date": "string",
      "due_date": "string",
      "completion_time_unit": "string",
      "completion_time_value": "string",
      "publish_time": "string",
      "status": {
        "id": 0,
        "state": "not_completed",
        "mark": "string",
        "mark_relative": 0,
        "ticked": "yes",
        "allow_attachments": true,
        "allow_marking_completed": true,
        "first_seen_date": "string",
        "last_seen_date": "string",
        "attachments": [
          {
            "id": 0,
            "file_name": "string",
            "file": "string",
            "validated_file": "string",
            "teacher_note": "string",
            "teacher_homework_attachments": [
              {
                "id": 0,
                "file_name": "string",
                "file": "string",
                "validated_file": "string"
              }
            ],
            "can_delete": true
          }
        ],
        "has_feedback": true
      },
      "validated_links": [
        {
          "link": "string",
          "validated_link": "string"
        }
      ],
      "validated_attachments": [
        {
          "id": 0,
          "file_name": "string",
          "file": "string",
          "validated_file": "string"
        }
      ]
    }
  ],
  "meta": {
    "start_date": "string",
    "end_date": "string",
    "display_type": "due_date",
    "max_files_allowed": 0,
    "allowed_file_types": [
      "string"
    ],
    "this_week_due_count": 0,
    "this_week_outstanding_count": 0,
    "this_week_completed_count": 0,
    "allow_attachments": true,
    "display_marks": true
  },
  "success": 0
}

List Detentions GET

Gets the student's detentions

List Lessons GET

Gets the student's lessons for a given date