Function: deleteEnrollmentsByActivityIdByMemberId()

deleteEnrollmentsByActivityIdByMemberId<ThrowOnError>(options): RequestResult<DeleteEnrollmentsByActivityIdByMemberIdResponses, DeleteEnrollmentsByActivityIdByMemberIdErrors, ThrowOnError>

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

Deletes a specific enrollment by its unique identifier. The DeleteEnrollment endpoint allows clients to remove an existing enrollment from the system based on the provided activity ID and member ID. This endpoint is designed to handle the deletion of enrollments, ensuring that proper authorization is enforced to allow only authorized users to delete enrollments, 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 deletion, the endpoint returns a 204 No Content status code, indicating that the enrollment has been successfully removed from the system without returning any content in the response body.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<DeleteEnrollmentsByActivityIdByMemberIdData, ThrowOnError>

Returns

RequestResult<DeleteEnrollmentsByActivityIdByMemberIdResponses, DeleteEnrollmentsByActivityIdByMemberIdErrors, ThrowOnError>