Function: getStudyenrollmentsById()

getStudyenrollmentsById<ThrowOnError>(options): RequestResult<GetStudyenrollmentsByIdResponses, GetStudyenrollmentsByIdErrors, ThrowOnError>

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

Retrieves the details of a specific study enrollment by its unique identifier. The GetStudyEnrollment endpoint provides a comprehensive view of a single enrollment record, including the associated study details, start/end dates, and the current status of the enrollment. This granular access is necessary for verifying specific academic claims or troubleshooting individual member profiles. If the enrollment record is not found or access is denied, the endpoint returns the appropriate HTTP status code.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<GetStudyenrollmentsByIdData, ThrowOnError>

Returns

RequestResult<GetStudyenrollmentsByIdResponses, GetStudyenrollmentsByIdErrors, ThrowOnError>