Function: getStudyenrollments()

getStudyenrollments<ThrowOnError>(options?): RequestResult<GetStudyenrollmentsResponses, GetStudyenrollmentsErrors, ThrowOnError>

Defined in: app/api/sdk.gen.ts:1065

Retrieves a list of study enrollments based on the provided query parameters. The GetStudyEnrollments endpoint allows authorized users to fetch enrollment records, which can be filtered and paginated via the GetStudyEnrollmentsDTO. This is primarily used by administrators to oversee student demographics or by individual users to view their own academic history within the system. The endpoint ensures that the returned data is scoped according to the requester's permissions, preventing unauthorized access to other members' academic records.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<GetStudyenrollmentsData, ThrowOnError>

Returns

RequestResult<GetStudyenrollmentsResponses, GetStudyenrollmentsErrors, ThrowOnError>