ClassCharts API Docs

List Announcements

Gets the student's announcements

GET
/announcements/{studentId}
/announcements/{studentId}

The Authorization access token

Authorization

Authorization
Required
Basic <token>

This is the session_id returned when logging in. e.g. Basic eW91IHNob3VsZCBzdGFyIHRoaXMgcmVwbyE=

In: header

Path Parameters

studentId
Required
integer

curl -X GET "https://www.classcharts.com/apiv2student/announcements/0" \
  -H "Authorization: Basic <token>"

Array of announcements

{
  "data": [
    {
      "id": 0,
      "title": "string",
      "description": "string",
      "school_name": "string",
      "teacher_name": "string",
      "school_logo": "string",
      "sticky": "yes",
      "state": "string",
      "timestamp": "string",
      "attachments": [
        {
          "filename": "string",
          "url": "string"
        }
      ],
      "for_pupils": [
        "string"
      ],
      "comment_visibility": "string",
      "allow_comments": "yes",
      "allow_reactions": "yes",
      "allow_consent": "yes",
      "priority_pinned": "yes",
      "requires_consent": "yes",
      "can_change_consent": true,
      "consent": {
        "consent_given": "yes",
        "comment": "string",
        "parent_name": "string"
      },
      "pupil_consents": [
        {
          "pupil": {
            "id": "string",
            "first_name": "string",
            "last_name": "string"
          },
          "can_change_consent": true,
          "consent": {
            "consent_given": "yes",
            "comment": "string",
            "parent_name": "string"
          }
        }
      ]
    }
  ],
  "meta": [],
  "success": 0
}