academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

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

AI-generated

Summary

Sends a request to transfer the exam enrolment for a specific grade from one exam to another.

Inputs

  • gradeId (required) — The grade ID. Used as a path parameter in the request URL: /api/v1/grades/{gradeId}/transfer-exam-enrolment.
  • data (required) — A fixed collection containing the 'type' of the resource. In the context of the API spec, this body structure is required for the transfer operation.
  • data.type (required) — The resource type identifier.
  • data.relationships (required) — A fixed collection containing the 'targetExam' relationship details.
  • data.relationships.targetExam (required) — A fixed collection containing the target exam data.
  • data.relationships.targetExam.data (required) — A fixed collection containing the target exam's 'type' and 'id'.
  • data.relationships.targetExam.data.type (required) — The resource type for the target exam.
  • data.relationships.targetExam.data.id (required) — The ID of the target exam.

Output shape

A list of items (one per input item) containing the JSON response from the API.

If the API returns a binary response, the node handles it automatically; otherwise, it returns the raw JSON.

Examples

Example 1: Transfer exam enrolment from Exam A to Exam B for a specific grade.

gradeId: 123, data.type: 'grades', data.relationships.targetExam.data.type: 'exams', data.relationships.targetExam.data.id: 456

Links

Discussion