Function: getEnrollments()

getEnrollments<ThrowOnError>(options?): RequestResult<GetEnrollmentsResponses, GetEnrollmentsErrors, ThrowOnError>

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

Retrieves a list of enrollments based on the provided filtering criteria. The GetEnrollments endpoint allows clients to fetch a collection of enrollments that match the specified criteria in the GetEnrollmentsDTO, such as filtering by member ID or activity ID. This endpoint is designed to return a list of enrollments, ensuring that proper authorization is enforced to allow only authorized users to access enrollment data, while also providing appropriate error handling for cases where enrollments may not be found or the user does not have access rights. Upon successful retrieval, the endpoint returns a list of enrollments with a 200 OK status code, allowing clients to easily access and display enrollment information as needed. This endpoint provides a convenient way for clients to stay informed about enrollment details related to specific members or activities by accessing the relevant enrollment data available within the system.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<GetEnrollmentsData, ThrowOnError>

Returns

RequestResult<GetEnrollmentsResponses, GetEnrollmentsErrors, ThrowOnError>