academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Exam-participant-add-reports [Beta] → Find exam-participant-add-reports

AI-generated

Summary

Finds exam participant add reports through the academyFIVE API, with optional filters, pagination, and sorting passed as query parameters.

Inputs

  • filter[examId] — Exam ID to filter results.
  • filter[profileName] — Name search string.
  • filter[bookingStatusIds] — Comma-separated booking status IDs.
  • filter[cohortIds] — Comma-separated cohort IDs.
  • filter[planningGroupIds] — Comma-separated planning group IDs.
  • filter[isCurriculumCheck] — Filter potential bookings by whether the curriculum includes the exam's subject.
  • filter[hasExamAdmission] — Filter bookings by whether they have an exam admission for the subject.
  • filter[isPassingGrade] — Filter bookings by whether they already have a passing grade, for grade improvement.
  • page[number] — Page number; the UI description specifies a default of 1.
  • page[size] — Number of results per page; the UI description specifies a default of 10.
  • sort — Sort order. Allowed values: profileName, cohortName, creditsInfo, planningGroupNames, curriculumSubjectVersion, isRepeater, hasExamAdmission, examAttempts.

Output shape

A list of items containing the API response data.

The operation sends the configured values as query parameters and returns the response as JSON items, paired with their input items. Pagination is controlled by page[number] and page[size]; the operation does not show logic to fetch subsequent pages automatically. If Continue On Fail is enabled, an item error is returned as {"error":"..."}.

Links

Discussion