Reports

Get a report with its steps

Changed on

Requires permission: StaffMember

Returns a report's details (with completion stats) and its steps, each step carrying its mark-grade fields (and options) plus its entry count.

get/reports/{id}

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/reports/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Response

Success - Retrieved report

namestring required
academicYearinteger
yearGroupstring required
publishToParentsstring date-time required
publishToStudentsstring date-time required
sportAllocationboolean
draftboolean
hiddenboolean
totalinteger
completeinteger

Changes

  • 49f6b0978a48Revision changes
    • 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

    • 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

    • 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

  • e15a351e2573Revision changes
    • breaking

      the /////////////// response's property format changed from int32 to int64 for status

    • breaking

      the /////////////// response's property format changed from int32 to int64 for status