Sign in
Exams

Send results statements to candidates

Changed on

Requires permission: ExamAdmin

Pupils only. Each recipient's PDF is built inside the per-recipient loop and asserted against that recipient before anything is queued, so no message can carry another candidate's results. Every outcome is recorded, so a part-completed send can be resumed without sending anyone a second copy. DryRun reports and sends nothing.

post/Exams/Results/Statements/Send

Request

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

Query parameters

pageinteger required
pageSizeinteger required
includesstring[] nullable
sortstring nullable
filterstring nullable

Request body

yearinteger
upisstring[]
subjectstring nullable
bodyHtmlstring nullable
replyTostring nullable
dryRunboolean

Response

Success

sendIdstring guid
dryRunboolean
queuedinteger
sentinteger
failedinteger
lockdownWarningstring nullable
messagestring nullable

Changes