Function: getAnnouncementsById()

getAnnouncementsById<ThrowOnError>(options): RequestResult<GetAnnouncementsByIdResponses, GetAnnouncementsByIdErrors, ThrowOnError>

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

Retrieves a specific announcement by its unique identifier. The GetAnnouncement endpoint allows clients to fetch the details of a single announcement based on the provided ID. This endpoint is designed to return the announcement data, ensuring that proper authorization is enforced to allow only authorized users to access the announcement information, while also providing appropriate error handling for cases where the announcement may not be found or the user does not have access rights. Upon successful retrieval, the endpoint returns the details of the specified announcement with a 200 OK status code, allowing clients to easily access and display specific announcement information as needed. This endpoint provides a convenient way for clients to stay informed about important updates, events, or news related to the organization or community by accessing detailed information about individual announcements available within the system.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<GetAnnouncementsByIdData, ThrowOnError>

Returns

RequestResult<GetAnnouncementsByIdResponses, GetAnnouncementsByIdErrors, ThrowOnError>