academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Grades → Transfers the exam enrolment from one exam to another.

AI-generated

Summary

Transfer an exam enrolment identified by a specific grade ID from one exam to another within the academyFIVE system.

Inputs

  • gradeId (required) — The ID of the grade representing the current exam enrolment to transfer.
  • data (required) — An object containing the request body data with required 'type' string and 'relationships' specifying the 'targetExam' details (including its 'type' and 'id').

Output shape

a JSON array containing the response data for each input item processed, corresponding to the transfer result or error information.

Requires 'gradeId' path parameter and a structured 'data' request body including 'type' and 'relationships.targetExam' (with nested 'type' and 'id'). Errors are returned inline if continueOnFail is enabled.

Links

Discussion