Function: getStudiesById()

getStudiesById<ThrowOnError>(options): RequestResult<GetStudiesByIdResponses, GetStudiesByIdErrors, ThrowOnError>

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

Retrieves the details of a specific study by its unique identifier. The GetStudy endpoint allows clients to fetch in-depth information about a single academic program, including its properties and associated metadata. This granular access is vital for displaying detailed program descriptions or verifying specific study configurations before administrative updates. If the study is not found, the endpoint returns a 404 Not Found status.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<GetStudiesByIdData, ThrowOnError>

Returns

RequestResult<GetStudiesByIdResponses, GetStudiesByIdErrors, ThrowOnError>