DeleteStudyenrollmentsById

Function: deleteStudyenrollmentsById()

deleteStudyenrollmentsById<ThrowOnError>(options): RequestResult<DeleteStudyenrollmentsByIdResponses, DeleteStudyenrollmentsByIdErrors, ThrowOnError>

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

Permanently removes a study enrollment record from the system. The DeleteStudyEnrollment endpoint allows for the removal of incorrectly entered or obsolete enrollment data. This operation is strictly guarded to prevent accidental loss of academic history and requires the requester to have administrative rights or ownership of the record. Following successful deletion, a 204 No Content status is returned to the client.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<DeleteStudyenrollmentsByIdData, ThrowOnError>

Returns

RequestResult<DeleteStudyenrollmentsByIdResponses, DeleteStudyenrollmentsByIdErrors, ThrowOnError>

On this page