POST enrollments
BearerAuthorizationBearer <token>Paste your JWT token here
The data transfer object containing the enrollment data.
application/json- body
Defines Data Transfer Object (DTO) for posting enrollments, containing the necessary information for creating a new enrollment, including the activity ID, member ID, and any specification answers provided by the member. The PostEnrollmentDTO is used to transfer data from the client to the server when creating a new enrollment, ensuring that all required information is provided and validated appropriately for the enrollment creation process.
activityId?integerReference to the unique identifier of the activity which is enrolled for.
int32memberId?stringThe ID of the user, as determined by the used OAuth application, which enrolls for the activity.
uuidspecificationAnswers?array<>|The answers for the specification questions associated with this enrollment.
Created
application/json- response
Represents the response DTO for an enrollment, containing all relevant information about the enrollment, including its properties and information about the associated member and activity. The EnrollmentResponseDTO is used to transfer comprehensive enrollment data from the server to the client when retrieving enrollment information, allowing for a complete representation of the enrollment's details, member information, activity information, and any specification answers provided by the member in the response payload.
isOnWaitingList*booleanIf the enrollment is placed on a waiting list due to the associated activity being fully booked, this field indicates the position of the enrollment on the waiting list.
registeredOn*stringThe date and time at which the enrollment was placed.
date-timemember*Defines the DTO for retrieving member information, containing all relevant details about a member, including personal information, contact details, and any associated data such as study enrollments and group memberships. The MemberResponseDTO is used to transfer comprehensive member data from the server to the client when retrieving member information, allowing for a complete representation of the member's details in the response payload. The MemberResponseDTO can include properties such as the member's unique identifier, name, email, phone number, address details, date of birth, mail subscriptions, preferred language, and any associated study enrollments or group memberships, providing a comprehensive view of the member data for the client application.
specificationAnswers?array<>|The answers for the specification questions associated with this enrollment.
price?|The price paid for the enrollment.
doubleactivity*Represents the response DTO for an activity, containing all relevant information about the activity, including its properties and related entities such as enrollments and specification questions. The ActivityResponseDTO is used to transfer comprehensive activity data from the server to the client when retrieving activity information, allowing for a complete representation of the activity's details, enrollment status, and associated specification questions in the response payload.
curl -X POST 'https://example.com/enrollments' \ -H 'Content-Type: application/json' \ -d '{}'{ "isOnWaitingList": true, "registeredOn": "2019-08-24T14:15:22Z", "member": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "studentNumber": "string", "firstName": "string", "lastName": "string", "email": "user@example.com", "phoneNumber": "string", "street": "string", "houseNumber": "string", "postalCode": "string", "city": "string", "dateOfBirth": "2019-08-24T14:15:22Z", "parentPhoneNumber": "string", "notes": "string", "registeredOn": "2019-08-24T14:15:22Z", "preferredLanguage": "NL", "studyEnrollments": [ { "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" } ], "groupMemberships": [ { "id": 0, "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e", "memberName": "string", "groupId": 0, "groupName": "string", "groupType": "Committee", "membershipYear": 0, "roleAliasId": 0, "roleAliasName": "string" } ], "gratie": true, "lidVanVerdienste": true, "ereLid": true, "begunstiger": true, "suspended": true, "profilePicturePath": "string" }, "specificationAnswers": [ { "questionId": 0, "answerId": 0, "answer": "string", "isPublic": true } ], "price": 0, "activity": { "id": 0, "name": "string", "price": 0.1, "posterPath": "string", "posterFileName": "string", "dutchDescription": "string", "englishDescription": "string", "dateTimeStart": "2019-08-24T14:15:22Z", "dateTimeEnd": "2019-08-24T14:15:22Z", "unenrollmentDeadline": "2019-08-24T14:15:22Z", "enrollmentDeadline": "2019-08-24T14:15:22Z", "enrollOpenDate": "2019-08-24T14:15:22Z", "location": "string", "participantLimit": 0, "organizerId": 0, "showInKoala": true, "showOnWebsite": true, "isEnrollable": true, "areParticipantsVisible": true, "isAdultOnly": true, "allowedAudience": "None", "isWeeklyDrinks": true, "vatRate": 0, "glAccountId": "string", "costCenterId": "string", "costUnitId": "string", "enrollments": [ {} ], "specificationQuestions": [ { "questionDutch": "string", "questionEnglish": "string", "type": "String", "isMandatory": true, "isPublic": true, "options": [ "string" ], "closeOnUnenrollmentDeadline": true, "id": 0 } ], "paymentDeadline": "2019-08-24T14:15:22Z", "isOpenForPayment": true }}