Exams

Get Exam Results for the whole School

Changed on

Requires permission: ExamAdmin

Get every pupil's exam results and component marks for one exam year, or a single pupil's full history when Upi is supplied. Release dates in EX_Settings are applied unless BypassLockdown is set by a caller holding ExamAdmin.

get/Exams/Results/School

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/Exams/Results/School
  • Auth: HTTP bearer

Query parameters

yearinteger nullable
upistring guid nullable
levelstring nullable
includeComponentMarksboolean required
includeOtherCentresboolean required
bypassLockdownboolean required
pageinteger required
pageSizeinteger required
includesstring[] nullable
sortstring nullable
filterstring nullable

Response

Success - Success

availableYearsinteger[]
yearinteger nullable
lockdownBypassedboolean
hiddenByLockdowninteger
centreScopestring nullable
componentMarksVisibleboolean
currentDateTimestring date-time nullable
currentDateTimeUtcstring date-time nullable

Changes

  • 49f6b0978a48Revision changes
    • breaking

      added the new required query request parameter includeOtherCentres

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 81ad1261a387Revision changes
    • info

      endpoint added