Function: getMailinglistsById()

getMailinglistsById<ThrowOnError>(options): RequestResult<GetMailinglistsByIdResponses, GetMailinglistsByIdErrors, ThrowOnError>

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

Retrieves a specific mailing list by its ID. This endpoint allows authorized users to fetch the details of a single mailing list identified by its unique ID. The method calls the GetMailinglist function of the IMailinglistService, passing the ID and cancellation token to retrieve the corresponding mailing list entity from the data layer. If the mailing list is found, it is returned as an HTTP 200 OK response; if not found, a 404 Not Found response is returned. The endpoint also handles exceptions, returning a 403 Forbidden response for unauthorized access and a 400 Bad Request response for other errors. This functionality is crucial for users to view and manage specific mailing lists within the application.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options

Options<GetMailinglistsByIdData, ThrowOnError>

Returns

RequestResult<GetMailinglistsByIdResponses, GetMailinglistsByIdErrors, ThrowOnError>