API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · enrollments

Enrollment Schema

Schema-ID
enrollment
Collection
enrollments
Permissions
  • Lesenenrollment_view
  • Anlegenenrollment_create
  • Ändernenrollment_edit
  • Löschenenrollment_delete
Beziehungen

Felder

Enrollment Schema

enrollments4 Permissions

Schema for validating student enrollment entities in the Academy/LMS module

courseIdstringerforderlich

ID of the course the student is enrolled in

min 1 Zeichen
userIdstringerforderlich

ID of the enrolled student

min 1 Zeichen
statusstringerforderlich

Current enrollment status. pending_payment is set for Stripe-direct charges before the PaymentIntent succeeds (ADR 0066b Phase 3). pending_approval/rejected gate self-enrollment behind team-lead approval (WP-D).

activecompleteddroppedsuspendedpending_paymentpending_approvalrejected
enrolledAtdatetimeerforderlich

Date and time when the student enrolled

completedAtdatetimeoptional

Date and time when the course was completed

nullable
feedbackRatingnumberoptional

Completion feedback: 1–5 star satisfaction rating (WP-B).

1 – 5nullable
feedbackCommentstringoptional

Completion feedback: free-text comment (WP-B).

max 2000 Zeichennullable
feedbackNpsnumberoptional

Completion feedback: optional 0–10 recommendation score (NPS, WP-B).

0 – 10nullable
feedbackAtdatetimeoptional

When completion feedback was submitted (WP-B).

nullable
submittedByUserIdstringoptional

User who self-enrolled and triggered the approval request (WP-D).

nullable
reviewedByUserIdstringoptional

Team lead / approver who approved or rejected the enrollment (WP-D).

nullable
rejectionReasonstringoptional

Reason given when an enrollment was rejected (WP-D).

max 1000 Zeichennullable
progressnumbererforderlich

Course completion progress as percentage

0 – 100
lastAccessedAtdatetimeoptional

Last time the student accessed the course

nullable
certificateIssuedbooleanoptional

Whether a certificate has been issued for completion

nullable
certificateIssuedAtdatetimeoptional

Date and time when the certificate was issued

nullable
gradebookEntryIdstringoptional

ID of the associated gradebook entry

nullable
currentLessonIdstringoptional

ID of the last lesson/section the student visited

nullable
currentUnitIdstringoptional

ID of the last learning unit the student visited

nullable
consumerTenantIdstringoptional

Tenant the learner belongs to, when different from the course owner. Null for MSP-internal enrollments.

nullable
shareIdstringoptional

course_shares row that authorised this cross-tenant enrollment.

nullable
pricingSnapshotobjectoptional

Frozen pricing at enrollment time (set on cross-tenant enrollments).

nullable
modestringoptional
freefixed_per_seat
amountCentsintegeroptional
≥ 0
currencystringoptional
taxRatePercentnumberoptional
0 – 100
enrolledCourseVersionintegeroptional

Course.contentVersion at the moment of enrollment. The frontend compares with the current course version and warns the learner if the course was updated mid-flight.

≥ 1nullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/enrollments — Liste, paginiert + filterbar
  • GET /api/v1/enrollments/<id> — Einzelne Entity
  • POST /api/v1/enrollments — Anlegen
  • PATCH /api/v1/enrollments/<id> — Teil-Update
  • DELETE /api/v1/enrollments/<id> — Soft-Delete
  • GET /api/v1/enrollments/<id>/timeline — Audit + Aktivitäten

Suche