Function: postEnrollments()

postEnrollments<ThrowOnError>(options?): RequestResult<PostEnrollmentsResponses, PostEnrollmentsErrors, ThrowOnError>

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

Creates a new enrollment based on the provided data. The PostEnrollment endpoint allows clients to submit a request to create a new enrollment by providing the necessary information in the PostEnrollmentDTO. This endpoint is designed to handle the creation of enrollments, ensuring that the provided data is validated and processed correctly, while also enforcing proper authorization to ensure that only authorized users can create new enrollments within the system. Upon successful creation, the endpoint returns the details of the newly created enrollment along with a 201 Created status code, allowing clients to easily access and reference the new enrollment in subsequent operations.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<PostEnrollmentsData, ThrowOnError>

Returns

RequestResult<PostEnrollmentsResponses, PostEnrollmentsErrors, ThrowOnError>