academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

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

AI-generated

Summary

Retrieves a paginated list of students currently locked out of their accounts based on specific process conditions.

Inputs

  • additionalFields (required) — A collection of query parameters for filtering results. Required parameters include filter[siteId], filter[bookingType], and filter[processConditionReasonTypeId]. Optional parameters include pagination (page[number], page[size]), booking status IDs, process condition IDs, and study program IDs.

Output shape

a list of items

Each item represents a student record. The node supports pagination via the page[number] and page[size] parameters.

Examples

Example 1: Fetch the first page of locked students for a specific site, booking type, and reason.

Set additionalFields.filter[siteId] to the site ID, filter[bookingType] to 1 (student), and filter[processConditionReasonTypeId] to 1 (matriculation).

Example 2: Retrieve a specific subset of students by their process condition and study program IDs.

Use filter[processConditionIds] and filter[studyProgramsIds] in additionalFields to narrow results.

Links

Discussion