Function: getEnrollmentsByActivityIdByMemberId()

getEnrollmentsByActivityIdByMemberId<ThrowOnError>(options): RequestResult<GetEnrollmentsByActivityIdByMemberIdResponses, GetEnrollmentsByActivityIdByMemberIdErrors, ThrowOnError>

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

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

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<GetEnrollmentsByActivityIdByMemberIdData, ThrowOnError>

Returns

RequestResult<GetEnrollmentsByActivityIdByMemberIdResponses, GetEnrollmentsByActivityIdByMemberIdErrors, ThrowOnError>