ClassCharts API Docs

List Rewards

Gets the available items in the student's rewards shop.

GET
/rewards/{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
curl -X GET "https://www.classcharts.com/apiv2student/rewards/0" \
  -H "Authorization: <token>"

Array of rewards

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "photo": "string",
      "price": 0,
      "stock_control": true,
      "stock": 0,
      "can_purchase": true,
      "unable_to_purchase_reason": "string",
      "once_per_pupil": true,
      "purchased": true,
      "purchased_count": 0,
      "price_balance_difference": 0
    }
  ],
  "meta": {
    "pupil_score_balance": 0
  },
  "success": 0
}

Get Student Code POST

Gets the student's student code

Purchase Reward POST

Purchase a reward item from the student's rewards shop.