Reports

Create a report draft

Changed on

Requires permission: ReportAdmins

Persists a report detail row (created in draft from the setup screen). Port of the legacy v2 PostCreateReportDetails (Update upsert on ReportDetail).

post/reports/setup

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/reports/setup
  • Auth: HTTP bearer

Request body

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

Response

Success - Report created as draft (returns the new report id)

Changes

  • 87818d31ea72Revision changes
    • breaking

      removed the success response with the status

    • info

      added the success response with the status