academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Process-condition-reports [Beta] → List students with active account locks by process condition

AI-generated

Summary

Lists students with active account locks for a process condition, using the academyFIVE API. Set the site, booking type, and process condition reason type filters; optionally narrow the report by booking statuses, process conditions, or study programs, and choose a page and page size.

Inputs

  • filter[siteId] (required) — Site ID to report on.
  • filter[bookingType] (required) — Booking type: 1 for student or 2 for applicant.
  • filter[processConditionReasonTypeId] (required) — Reason type: 1 for matriculation, 2 for examtriculation, or 3 for re-registration.
  • page[number] — Page number to retrieve; the UI description says it starts at 1 and defaults to 1.
  • page[size] — Number of results per page; the UI description says the default is 50.
  • filter[bookingStatusIds] — Comma-separated booking status IDs to include.
  • filter[processConditionIds] — Comma-separated process condition IDs to include.
  • filter[studyProgramsIds] — Comma-separated study program IDs to filter by.

Output shape

A list of JSON items containing the API response data.

The operation sends the configured values as query parameters. Pagination may limit the results. The node wraps the response as JSON items and pairs them with the corresponding input item; with Continue On Fail enabled, an item contains an error message instead.

Links

Discussion