Reports Endpoint

This endpoint returns all the reports available to a user.

/api/reports/{token}

key	required	default value	datatype	description
userID	false	null	String	though not required, it can be provided to skip the step of calculation for optimisation

📝️

Please Note: Students cannot access their own reports. Due to the way CaulfieldLife is structured, a parent token is required to be able to access reports, and is not available to any students.

The times from the timetable endpoint are in GMT time, which might be why they appear offset from the real time. For example, in Melbourne (GMT+10), the time would look 10 hours behind.

Example

https://caulfieldsync.vercel.app/api/reports/sampleToken

An example response would be as follows:

{
  "data": {
    "membersReports": [
      {
        "semester": "2",
        "externalId": "WrJQYa-4239",
        "memberId": "cjw0mjhvf1fac0993081nfrp6",
        "year": "2022",
        "file": "https://life-api.caulfieldlife.com.au/sentral/reports/WrJQYa-4239/file?temp=JsonWebToken",
        "name": "Student_Report_322",
        "reportingPeriod": "Yarra Junction 8C WH 2022",
        "__typename": "Report"
      },
      {
        "semester": "1",
        "externalId": "VxWeYK-1088",
        "memberId": "cjw0mjhvf1fac0993081nfrp6",
        "year": "2019",
        "file": "https://life-api.caulfieldlife.com.au/sentral/reports/VxWeYK-1088/file?temp=JsonWebToken",
        "name": "Student_Report_970",
        "reportingPeriod": "Semester 1 2019",
        "__typename": "Report"
      },
      {
        "semester": "2",
        "externalId": "VxWeYK-4000",
        "memberId": "cjw0mjhvf1fac0993081nfrp6",
        "year": "2019",
        "file": "https://life-api.caulfieldlife.com.au/sentral/reports/VxWeYK-4000/file?temp=JsonWebToken",
        "name": "Student_Report_719",
        "reportingPeriod": "Semester 2, 2019",
        "__typename": "Report"
      },
      {
        "semester": "1",
        "externalId": "VxWeYK-7129",
        "memberId": "cjw0mjhvf1fac0993081nfrp6",
        "year": "2020",
        "file": "https://life-api.caulfieldlife.com.au/sentral/reports/VxWeYK-7129/file?temp=JsonWebToken",
        "name": "Student_Report_689",
        "reportingPeriod": "Semester 1, 2020",
        "__typename": "Report"
      },
      {
        "semester": "2",
        "externalId": "VxWeYK-16032",
        "memberId": "cjw0mjhvf1fac0993081nfrp6",
        "year": "2020",
        "file": "https://life-api.caulfieldlife.com.au/sentral/reports/VxWeYK-16032/file?temp=JsonWebToken",
        "name": "Student_Report_792",
        "reportingPeriod": "WH Semester 2 Reports 2020",
        "__typename": "Report"
      },
      {
        "semester": "1",
        "externalId": "VxWeYK-19889",
        "memberId": "cjw0mjhvf1fac0993081nfrp6",
        "year": "2021",
        "file": "https://life-api.caulfieldlife.com.au/sentral/reports/VxWeYK-19889/file?temp=JsonWebToken",
        "name": "Student_Report_207",
        "reportingPeriod": "WH Semester 1 Reports, 2021",
        "__typename": "Report"
      },
      {
        "semester": "2",
        "externalId": "VxWeYK-24054",
        "memberId": "cjw0mjhvf1fac0993081nfrp6",
        "year": "2021",
        "file": "https://life-api.caulfieldlife.com.au/sentral/reports/VxWeYK-24054/file?temp=JsonWebToken",
        "name": "Student_Report_74",
        "reportingPeriod": "WH Semester 2 Reports 2021",
        "__typename": "Report"
      },
      {
        "semester": "1",
        "externalId": "VxWeYK-24981",
        "memberId": "cjw0mjhvf1fac0993081nfrp6",
        "year": "2022",
        "file": "https://life-api.caulfieldlife.com.au/sentral/reports/VxWeYK-24981/file?temp=JsonWebToken",
        "name": "Student_Report_861",
        "reportingPeriod": "WH Interim Reports Semester 1, 2022",
        "__typename": "Report"
      },
      {
        "semester": "1",
        "externalId": "VxWeYK-26700",
        "memberId": "cjw0mjhvf1fac0993081nfrp6",
        "year": "2022",
        "file": "https://life-api.caulfieldlife.com.au/sentral/reports/VxWeYK-26700/file?temp=JsonWebToken",
        "name": "Student_Report_720",
        "reportingPeriod": "WH Semester 1 Reports, 2022",
        "__typename": "Report"
      },
      {
        "semester": "2",
        "externalId": "VxWeYK-29340",
        "memberId": "cjw0mjhvf1fac0993081nfrp6",
        "year": "2022",
        "file": "https://life-api.caulfieldlife.com.au/sentral/reports/VxWeYK-29340/file?temp=JsonWebToken",
        "name": "Student_Report_48",
        "reportingPeriod": "WH Interim Reports Semester 2 2022",
        "__typename": "Report"
      }
    ]
  }
}