ClassCharts API Docs

List Behaviour

Gets the student's behaviour.

GET
/behaviour/{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
Format: "date"
curl -X GET "https://www.classcharts.com/apiv2student/behaviour/0?from=2019-08-24&to=2019-08-24" \
  -H "Authorization: <token>"

Array of behaviour points

{
  "data": {
    "timeline": [
      {
        "positive": 0,
        "negative": 0,
        "name": "string",
        "start": "string",
        "end": "string"
      }
    ],
    "positive_reasons": {
      "property1": 0,
      "property2": 0
    },
    "negative_reasons": {
      "property1": 0,
      "property2": 0
    },
    "other_positive": [
      "string"
    ],
    "other_negative": [
      "string"
    ],
    "other_positive_count": [
      {}
    ],
    "other_negative_count": [
      {}
    ]
  },
  "meta": {
    "start_date": "string",
    "end_date": "string",
    "step_size": "string"
  },
  "success": 0
}

List Badges GET

Gets the student's earned badges

List Classes GET

Lists the student's classes