PostStudyenrollments

Function: postStudyenrollments()

postStudyenrollments<ThrowOnError>(options?): RequestResult<PostStudyenrollmentsResponses, PostStudyenrollmentsErrors, ThrowOnError>

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

Creates a new study enrollment record for a member. The PostStudyEnrollment endpoint processes requests to link a member to a specific academic study using the PostStudyEnrollmentDTO. This operation involves validating the enrollment period and ensuring the member is not already enrolled in a conflicting program. The endpoint enforces authorization to ensure that users can only create enrollments for themselves or, in the case of staff, for other members. Upon success, it returns the newly created enrollment details.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<PostStudyenrollmentsData, ThrowOnError>

Returns

RequestResult<PostStudyenrollmentsResponses, PostStudyenrollmentsErrors, ThrowOnError>

On this page