StudyEnrollmentResponseDto
Type Alias: StudyEnrollmentResponseDto
[object Object]
Defined in: app/api/types.gen.ts:1753
Represents the response DTO for a study enrollment, containing all relevant information about the study enrollment, including its properties and any associated data. The StudyEnrollmentResponseDTO is used to transfer comprehensive study enrollment data from the server to the client when retrieving study enrollment information, allowing for a complete representation of the study enrollment's details in the response payload. The StudyEnrollmentResponseDTO can include properties such as the enrollment ID, member ID, member name, study ID, study title, study type, enrollment date, completion date, and status, providing a comprehensive view of the study enrollment data for the client application.
Properties
completionDate?
optionalcompletionDate?:string|null
Defined in: app/api/types.gen.ts:1782
The date and time when the enrollment ended, if applicable.
enrollmentDate
[object Object]
Defined in: app/api/types.gen.ts:1778
The date and time when the enrollment started.
id
[object Object]
Defined in: app/api/types.gen.ts:1757
The unique identifier of a study enrollment, assigned incrementally.
memberId?
optionalmemberId?:string|null
Defined in: app/api/types.gen.ts:1761
The member associated with this enrollment.
memberName?
optionalmemberName?:string|null
Defined in: app/api/types.gen.ts:1765
Represents a member of the organization. A member has various properties such as personal information, contact details, registration date, and relationships with other entities such as enrollments, group memberships, and announcements. This entity is used to manage and organize members within the system, allowing for better communication, access control, and personalized experiences based on member preferences and attributes.
status
[object Object]
Defined in: app/api/types.gen.ts:1783
studyId?
optionalstudyId?:number|null
Defined in: app/api/types.gen.ts:1769
The study associated with this enrollment.
studyTitle?
optionalstudyTitle?:string|null
Defined in: app/api/types.gen.ts:1773
Represents a study program. A Study has a unique identifier, a title, a nominal duration in years, and a type (e.g., Bachelor, Master). Each Study can have multiple enrollments associated with it through the StudyEnrollment entity. This entity is used to manage and organize different study programs within the system, allowing for better tracking of student enrollments and academic programs offered by the organization.
studyType?
optionalstudyType?:StudyType
Defined in: app/api/types.gen.ts:1774