Type Alias: GetMembersData

[object Object]

Defined in: app/api/types.gen.ts:2839

Properties

body?

optional body?: never

Defined in: app/api/types.gen.ts:2840

path?

optional path?: never

Defined in: app/api/types.gen.ts:2841

query?

optional query?: object

Defined in: app/api/types.gen.ts:2842

Indicates whether to include inactive members in the retrieved member data. If set to true, both active and inactive members will be included in the response; if set to false, only active members will be included. This field allows for filtering members based on their active status, enabling the retrieval of either all members or only those that are currently active in the system based on the provided criteria in the request payload. The GetMembersDto ensures that member data is retrieved with the necessary information to effectively filter and manage member information based on their active status, providing a structured and validated approach to member retrieval in the application.

LidVanVerdienste?

optional LidVanVerdienste?: boolean

Page?

optional Page?: number

The page number to be retrieved when paginating member data. This field is used to specify the page of member records to be included in the response when retrieving member information in a paginated format. The Page property is essential for controlling the specific page of member data returned in the response, allowing for efficient retrieval and display of member information in the client application based on pagination criteria in the system.

PageSize?

optional PageSize?: number

The size of the page to be retrieved when paginating member data. This field is used to specify the number of member records to be included in each page of the response when retrieving member information in a paginated format. The PageSize property is essential for controlling the amount of member data returned in each page, allowing for efficient retrieval and display of member information in the client application based on pagination criteria in the system.

Search?

optional Search?: string

The search term used to filter members based on their first name, last name, or email. This field allows for searching and retrieving members that match the specified search criteria, enabling users to quickly find members based on their name or email information in the system. The Search property is essential for providing a convenient and efficient way to filter member data based on relevant keywords, enhancing the user experience when retrieving member information in the client application based on their name or email details in the system.

StudyId?

optional StudyId?: number

The unique identifier of the study for which to filter members based on their study enrollments. This field is optional, and if provided, it allows for filtering members based on their association with a specific study, enabling the retrieval of members that are enrolled in a particular study within the system. If not provided, member data may be retrieved without any study-specific filtering, allowing for a broader retrieval of member information based on other criteria or without any specific filtering based on study enrollments in the system.

StudyType?

optional StudyType?: StudyType

Suspended?

optional Suspended?: boolean

url

[object Object]

Defined in: app/api/types.gen.ts:2870

GetMembersData