POST studyenrollments
BearerAuthorizationBearer <token>Paste your JWT token here
The data transfer object containing the new enrollment configuration.
application/json- body
Defines the DTO for posting a study enrollment, containing the necessary information for creating a new study enrollment, including the study ID, member ID, enrollment date, and status. The PostStudyEnrollmentDTO is used to transfer data from the client to the server when creating a new study enrollment, ensuring that all required information is provided and validated appropriately for the creation process.
studyId*integerThe study associated with this enrollment.
int32memberId*stringThe member associated with this enrollment.
uuidenrollmentDate*stringThe date and time when the enrollment started.
date-timestatus?StudyStatusDefines the status of a study enrollment, indicating whether the enrollment is currently active (Enrolled), has been completed (Completed), or has been dropped out (DroppedOut). The StudyStatus enum is used to track the current state of a study enrollment, allowing for better management and organization of student enrollments within the system. This status information can be crucial for various functionalities such as reporting, analytics, and determining eligibility for certain activities or programs based on the student's enrollment status in their study program.
int32"Enrolled""Completed""DroppedOut"Created
application/json- response
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.
id*integerThe unique identifier of a study enrollment, assigned incrementally.
int32memberId?|The member associated with this enrollment.
uuidmemberName?|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.
studyId?|The study associated with this enrollment.
int32studyTitle?|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?StudyTypeDefines the type of a Study.
int32"Bachelor""Master"enrollmentDate*stringThe date and time when the enrollment started.
date-timecompletionDate?|The date and time when the enrollment ended, if applicable.
date-timestatus*StudyStatusDefines the status of a study enrollment, indicating whether the enrollment is currently active (Enrolled), has been completed (Completed), or has been dropped out (DroppedOut). The StudyStatus enum is used to track the current state of a study enrollment, allowing for better management and organization of student enrollments within the system. This status information can be crucial for various functionalities such as reporting, analytics, and determining eligibility for certain activities or programs based on the student's enrollment status in their study program.
int32"Enrolled""Completed""DroppedOut"curl -X POST 'https://example.com/studyenrollments' \ -H 'Content-Type: application/json' \ -d '{ "studyId": 0, "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e", "enrollmentDate": "2019-08-24T14:15:22Z"}'{ "id": 0, "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e", "memberName": "string", "studyId": 0, "studyTitle": "string", "studyType": "Bachelor", "enrollmentDate": "2019-08-24T14:15:22Z", "completionDate": "2019-08-24T14:15:22Z", "status": "Enrolled"}