Function: getActivitiesByIdEnrollmentsExport()

getActivitiesByIdEnrollmentsExport<ThrowOnError>(options): RequestResult<GetActivitiesByIdEnrollmentsExportResponses, GetActivitiesByIdEnrollmentsExportErrors, ThrowOnError>

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

Exports the enrollments for a specific activity by its unique identifier in CSV format. The ExportEnrollments endpoint allows clients to fetch the enrollment data associated with an existing activity based on the provided ID, specifically formatted as a CSV file for easy analysis and reporting. This endpoint is designed to return the enrollment data in a structured CSV format, ensuring that proper authorization is enforced to allow only authorized users to access enrollment information, while also providing appropriate error handling for cases where the activity or enrollments may not be found. Upon successful retrieval, the endpoint returns the enrollment data as a downloadable CSV file with a filename, allowing clients to easily export and manage enrollment information for activities as needed. This endpoint provides a convenient way for clients to access and utilize enrollment data within their applications by enabling direct downloads of enrollment information in a widely used format.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<GetActivitiesByIdEnrollmentsExportData, ThrowOnError>

Returns

RequestResult<GetActivitiesByIdEnrollmentsExportResponses, GetActivitiesByIdEnrollmentsExportErrors, ThrowOnError>