GET studyenrollments Id

GET
/studyenrollments/{id}

Authorization

Bearer
headerAuthorizationBearer <token>

Paste your JWT token here

Path Parameters

id*integer

The unique identifier of the study enrollment to retrieve.

Formatint32

Response Body

OK

application/json
  1. 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*integer

The unique identifier of a study enrollment, assigned incrementally.

Formatint32
memberId?|

The member associated with this enrollment.

Formatuuid
memberName?|

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.

Formatint32
studyTitle?|

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?StudyType

Defines the type of a Study.

Formatint32
Value in"Bachelor""Master"
enrollmentDate*string

The date and time when the enrollment started.

Formatdate-time
completionDate?|

The date and time when the enrollment ended, if applicable.

Formatdate-time
status*StudyStatus

Defines 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.

Formatint32
Value in"Enrolled""Completed""DroppedOut"
curl -X GET 'https://example.com/studyenrollments/0'
{  "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"}