Module

LMS

Das LMS verwaltet Schulungen für Mitarbeitende und (mit dazu lizensierter Academy-Lizenz) für Endkunden. Inhalte sind hierarchisch: Kurs → Lektion → Lerneinheit / Quiz. Zusätzlich gibt es Bezahl-Funktionen über Vouchers und Charges.

Resources

Resource	Pfad	Permission-Präfix	Sequenz
Kurse	`/api/v1/courses`	`course`	`CRS-`
Lektionen	`/api/v1/lessons`	`lesson`	`LSN-`
Lerneinheiten	`/api/v1/learning_units`	`learning_unit`	—
Quiz-Versuche	`/api/v1/quiz_attempts`	`quiz_attempt`	—
Anmeldungen	`/api/v1/enrollments`	`enrollment`	—
Fortschritt	`/api/v1/student_progress`	`student_progress`	—
Charges (Bezahlung)	`/api/v1/course_charges`	`course_charge`	—
Vouchers	`/api/v1/course_vouchers`	`course_voucher`	—
Cross-Tenant-Shares	`/api/v1/course_shares`	`course_share`	—

Quiz-Fragen, Antworten und Materialien liegen als typisierte Felder direkt am lesson bzw. learning_unit-Datensatz.

Schemas

Course

courses4 Permissions

Schema for validating course entities in the Academy/LMS module

title string erforderlich

Course title

1–200 Zeichen

description string optional

Course description

max 2000 Zeichennullable

category string erforderlich

Course category

1–100 Zeichen

lessons string[] optional

Array of lesson IDs

nullable

isPublished boolean erforderlich

Whether the course is published and visible to students

duration number erforderlich

Course duration in minutes

≥ 1

level string erforderlich

Course difficulty level

Werte

beginnerintermediateadvanced

authorId string optional

ID of the course author/instructor

nullable

maxEnrollments number optional

Maximum number of students that can enroll

≥ 1nullable

prerequisites string[] optional

Array of prerequisite course IDs

nullable

certificateTemplateId string optional

ID of the certificate template for completion

nullable

price number optional

Course price (0 for free courses)

≥ 0nullable

tags string[] optional

Course tags for categorization and search

nullable

isSystemCourse boolean optional

System-managed course that bypasses module licensing

nullable

targetAudience string optional

Target audience for this course (e.g. technicians, sales, new employees)

max 500 Zeichennullable

gradingEnabled boolean optional

Whether grading/gradebook is enabled for this course

nullable

passingScore number optional

Minimum score percentage required to pass the course

0 – 100nullable

certificateMode string optional

How certificates are issued: auto on completion, manual by instructor, or none

Werte

automanualnone

nullable

completionMode string optional

How course completion is determined

Werte

all_unitspercentagemanual

nullable

completionPercent number optional

Percentage of units required for completion (if completionMode=percentage)

0 – 100nullable

courseType string optional

Course type for special handling (e.g. uvv_training links to fleet module)

Werte

generaluvv_trainingonboardingcompliance

nullable

coverImageFileId string optional

File ID of the course cover image

nullable

contentVersion integer optional

Monotonic content version. Bumped via `POST /courses/:id/publish-version` when the author releases a substantive content change so in-flight enrollees can see "course was updated since you started" prompts.

≥ 1Default: 1

contentVersionPublishedAt datetime optional

When the current contentVersion was published.

Default: nullnullable

Lesson

lessons4 Permissions

Schema for validating lesson entities in the Academy/LMS module

courseId string erforderlich

ID of the course this lesson belongs to

min 1 Zeichen

title string erforderlich

Lesson title

1–200 Zeichen

content string erforderlich

Lesson content in markdown format

min 1 Zeichen

order number erforderlich

Order of lesson in the course

≥ 1

duration number erforderlich

Lesson duration in minutes

≥ 1

videoUrl uri optional

URL of lesson video

nullable

type string optional

Type of lesson content

Werte

videotextquizinteractive

nullable

isPreview boolean optional

Whether lesson can be accessed without enrollment

nullable

resources object[] optional

Additional resources for the lesson

nullable

name string erforderlich

min 1 Zeichen

type string erforderlich

Werte

pdflinkdownload

url uri erforderlich

size number optional

≥ 0nullable

unitCount number optional

Cached count of learning units in this section

≥ 0nullable

completionMode string optional

Whether units must be completed in order (sequential) or freely

Werte

sequentialfree

nullable

isLocked boolean optional

Whether this section is locked until the previous section is completed

nullable

requiredModule string optional

Module ID required to view this lesson (for onboarding filtering)

nullable

Learning-Unit

learning_units4 Permissions

Schema for individual learning units within a course section

lessonId string erforderlich

ID of the parent lesson/section (Lektion)

min 1 Zeichen

courseId string erforderlich

ID of the parent course (denormalized)

min 1 Zeichen

title string erforderlich

Learning unit title

1–200 Zeichen

type string erforderlich

Type of learning unit content

Werte

videotextquizexamfile_uploadltih5p

order number erforderlich

Position within the parent section

≥ 0

isPreview boolean optional

Whether unit can be accessed without enrollment

nullable

isPublished boolean optional

Whether the unit is visible to students

nullable

content string optional

TipTap JSON content for text units

nullable

videoUrl string optional

URL of the video

nullable

videoProvider string optional

Video hosting provider

Werte

uploadyoutubevimeoexternal

nullable

videoDurationSecs number optional

Total video duration in seconds

≥ 0nullable

questionPoolId string optional

ID of the question pool to draw from

nullable

questionCount number optional

Number of questions to draw randomly from pool

≥ 1nullable

timeLimitSecs number optional

Time limit in seconds (0 = no limit)

≥ 0nullable

passingScore number optional

Minimum score percentage to pass (0-100)

0 – 100nullable

maxAttempts number optional

Maximum number of attempts (null = unlimited)

≥ 1nullable

shuffleQuestions boolean optional

Whether to shuffle question order

nullable

shuffleOptions boolean optional

Whether to shuffle answer options

nullable

showCorrectAfter boolean optional

Whether to show correct answers after submission

nullable

isGraded boolean optional

Whether this unit counts toward gradebook/certificate (default: true for exam, false for quiz)

nullable

allowBackNavigation boolean optional

Whether students can navigate back to previous questions (default: true for quiz, false for exam)

nullable

isRequiredForCompletion boolean optional

Whether this unit must be completed for course completion (default: true for exam, false for quiz)

nullable

embeddedQuestions object[] optional

Inline quiz questions (alternative to question pool)

nullable

_id string erforderlich

min 1 Zeichenread-only

question string erforderlich

min 1 Zeichen

type string erforderlich

Werte

multiple_choicemultiple_responsetrue_falsefill_blankdropdown_blankmatchingorderingshort_text

options object[] optional

nullable

id string erforderlich

min 1 Zeichen

label string erforderlich

min 1 Zeichen

isCorrect boolean optional

nullable

correctAnswer oneOf erforderlich

points number erforderlich

≥ 0

explanation string optional

nullable

mediaUrl string optional

nullable

matchingPairs object[] optional

nullable

left string erforderlich

right string erforderlich

orderItems string[] optional

nullable

dropdownBlanks object[] optional

nullable

blank string erforderlich

options string[] erforderlich

correct string erforderlich

difficulty string optional

Werte

easymediumhard

nullable

gradingRubric string optional

nullable

aiPrompt string optional

nullable

tags string[] optional

nullable

gradingMethod string optional

How to calculate final grade from multiple attempts (default: highest)

Werte

highestaveragefirstlast

nullable

availableFrom datetime optional

Quiz opens at this time (ISO 8601)

nullable

availableUntil datetime optional

Quiz closes at this time (ISO 8601)

nullable

lateSubmissionPolicy string optional

What happens if submitted after availableUntil (default: none)

Werte

noneallow_with_penalty

nullable

lateSubmissionPenalty number optional

Percentage deducted for late submission (e.g., 20 = -20%)

0 – 100nullable

reviewOptions object optional

Granular review options per time window. Overrides showCorrectAfter when set.

nullable

immediatelyAfter object optional

nullable

showScore boolean optional

nullable

showCorrectAnswers boolean optional

nullable

showFeedback boolean optional

nullable

showPoints boolean optional

nullable

afterClose object optional

nullable

showScore boolean optional

nullable

showCorrectAnswers boolean optional

nullable

showFeedback boolean optional

nullable

showPoints boolean optional

nullable

attemptCooldownMins number optional

Minimum minutes to wait between attempts

≥ 0nullable

attemptPenaltyPercent number optional

Percentage deducted per subsequent attempt (e.g., 10 = attempt 2 loses 10%, attempt 3 loses 20%)

0 – 100nullable

uploadInstructions string optional

Instructions for file upload assignment

nullable

allowedFileTypes string[] optional

Allowed MIME types for uploads

nullable

maxFileSizeMb number optional

Maximum file size in MB

≥ 0nullable

ltiToolId string optional

ID of the registered LTI tool (lti_tools collection)

nullable

ltiCustomParams object optional

Custom parameters for this unit (merged with tool-level defaults)

nullable

ltiOpenInNewTab boolean optional

Open the tool in a new tab instead of an inline iframe

nullable

ltiPassingScore number optional

Minimum AGS score (0–100) required to auto-complete this unit

0 – 100nullable

h5pFileId string optional

ID of the uploaded .h5p file in files collection

nullable

h5pContentPath string optional

URL path to the extracted H5P content (set by worker after extraction)

nullable

h5pPassingScore number optional

Minimum xAPI score (0–100) required to auto-complete this unit

0 – 100nullable

requirements object optional

Completion requirements for this unit

nullable

minScore number optional

0 – 100nullable

videoMinPercent number optional

0 – 100nullable

textMinTimeSecs number optional

≥ 0nullable

textScrollPercent number optional

0 – 100nullable

fileUploadRequired boolean optional

nullable

manualApprovalRequired boolean optional

nullable

resources object[] optional

Additional resources attached to this unit

nullable

name string erforderlich

min 1 Zeichen

type string erforderlich

Werte

pdflinkdownload

url uri erforderlich

size number optional

≥ 0nullable

aiReviewEnabled boolean optional

Whether AI review is enabled for file upload submissions

nullable

aiReviewPrompt string optional

Custom AI prompt for reviewing file submissions

max 5000 Zeichennullable

aiReviewRubric string optional

Grading rubric for AI review of file submissions

max 10000 Zeichennullable

Quiz-Attempt

quiz_attempts4 Permissions

Schema for a student quiz or exam attempt

learningUnitId string erforderlich

ID of the quiz/exam learning unit

min 1 Zeichen

courseId string erforderlich

ID of the parent course (denormalized)

min 1 Zeichen

lessonId string erforderlich

ID of the parent lesson/section (denormalized)

min 1 Zeichen

enrollmentId string erforderlich

ID of the student enrollment

min 1 Zeichen

userId string erforderlich

ID of the student

min 1 Zeichen

attemptNumber number erforderlich

Sequential attempt number for this student and unit

≥ 1read-only

status string erforderlich

Current state of the attempt

Werte

in_progresssubmittedgradedpending_ai_reviewtimed_out

startedAt datetime erforderlich

When the attempt was started

submittedAt datetime optional

When the attempt was submitted

nullable

timeLimitSecs number optional

Time limit snapshot from unit at start of attempt

≥ 0nullable

score number optional

Raw score as percentage (0-100) after grading

0 – 100nullable

adjustedScore number optional

Score after applying attempt penalty and/or late submission penalty

≥ 0nullable

isPassed boolean optional

Whether the attempt meets the passing score threshold

nullable

gradingMethod string optional

Snapshot from unit: how to calculate final grade from multiple attempts

Werte

highestaveragefirstlast

nullable

reviewOptions object optional

Snapshot of review options from unit at start of attempt

nullable

attemptPenaltyPercent number optional

Snapshot from unit: percentage deducted per subsequent attempt

0 – 100nullable

lateSubmission boolean optional

Whether this attempt was submitted after availableUntil

nullable

lateSubmissionPenalty number optional

Late submission penalty applied (percentage)

0 – 100nullable

showCorrectAfter boolean optional

Snapshot from unit: whether to show correct answers after submission

nullable

allowBackNavigation boolean optional

Snapshot from unit: whether the student can navigate back during the attempt

nullable

answers object[] optional

Student answers for each question

nullable

questionId string erforderlich

min 1 Zeichen

questionSnapshot object erforderlich

Full question text and options at time of attempt

answer oneOf erforderlich

isCorrect boolean optional

nullable

pointsAwarded number optional

≥ 0nullable

gradedManually boolean optional

nullable

instructorNote string optional

nullable

pendingAiGrading boolean optional

nullable

aiFeedback string optional

nullable

aiPointsAwarded number optional

≥ 0nullable

aiConfidence number optional

0 – 1nullable

aiGradedAt datetime optional

nullable

Enrollment

enrollments4 Permissions

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

courseId string erforderlich

ID of the course the student is enrolled in

min 1 Zeichen

userId string erforderlich

ID of the enrolled student

min 1 Zeichen

status string erforderlich

Current enrollment status. pending_payment is set for Stripe-direct charges before the PaymentIntent succeeds (ADR 0066b Phase 3).

Werte

activecompleteddroppedsuspendedpending_payment

enrolledAt datetime erforderlich

Date and time when the student enrolled

completedAt datetime optional

Date and time when the course was completed

nullable

progress number erforderlich

Course completion progress as percentage

0 – 100

lastAccessedAt datetime optional

Last time the student accessed the course

nullable

certificateIssued boolean optional

Whether a certificate has been issued for completion

nullable

certificateIssuedAt datetime optional

Date and time when the certificate was issued

nullable

gradebookEntryId string optional

ID of the associated gradebook entry

nullable

currentLessonId string optional

ID of the last lesson/section the student visited

nullable

currentUnitId string optional

ID of the last learning unit the student visited

nullable

consumerTenantId string optional

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

nullable

shareId string optional

course_shares row that authorised this cross-tenant enrollment.

nullable

pricingSnapshot object optional

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

nullable

mode string optional

Werte

freefixed_per_seat

amountCents integer optional

≥ 0

currency string optional

taxRatePercent number optional

0 – 100

enrolledCourseVersion integer optional

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

Progress

student_progress4 Permissions

Schema for validating student progress tracking in the Academy/LMS module

enrollmentId string erforderlich

ID of the enrollment record

min 1 Zeichen

lessonId string erforderlich

ID of the lesson

min 1 Zeichen

userId string erforderlich

ID of the student

min 1 Zeichen

courseId string erforderlich

ID of the course

min 1 Zeichen

status string erforderlich

Current lesson progress status

Werte

not_startedin_progresscompleted

progress number erforderlich

Lesson completion progress as percentage

0 – 100

timeSpent number erforderlich

Time spent on this lesson in minutes

≥ 0

startedAt datetime optional

Date and time when the lesson was started

nullable

completedAt datetime optional

Date and time when the lesson was completed

nullable

quizScore number optional

Quiz score for quiz-type lessons (percentage)

0 – 100nullable

attempts number erforderlich

Number of attempts made on this lesson

≥ 0

Charge

course_charges4 Permissions

Billing record for one cross-tenant enrollment in a paid shared course

enrollmentId uuid erforderlich

read-only

courseId uuid erforderlich → course

read-only

shareId uuid erforderlich

read-only

consumerTenantId uuid erforderlich

Customer-tenant the learner belongs to (the bill recipient).

read-only

consumerUserId uuid erforderlich

User in the customer-tenant who triggered the enrollment.

read-only

grossAmountCents integer erforderlich

Gross charge in EUR cents (or `currency` cents) — what the customer owes.

≥ 0read-only

netAmountCents integer optional

Net of VAT.

≥ 0read-only

taxAmountCents integer optional

VAT amount.

≥ 0read-only

taxRatePercent number optional

0 – 100Default: 19

currency string erforderlich

Default: "EUR"

mspNetAmountCents integer erforderlich

What the MSP keeps after Codemeta platform fee.

≥ 0read-only

codemetaPlatformFeeCents integer erforderlich

Codemeta platform fee deducted from the charge.

≥ 0read-only

codemetaPlatformFeePercent number optional

Percentage of gross taken as platform fee at charge creation time.

0 – 100Default: 10read-only

status string erforderlich

Werte

pendinginvoicedpaidrefundedfailed

Default: "pending"

billingMode string erforderlich

wholesale: aggregated into customer wholesale invoice. direct_stripe: paid in real-time via Stripe Connect.

Werte

wholesaledirect_stripe

read-only

occurredAt datetime erforderlich

When the charge became applicable (= enrollment creation time).

read-only

invoicedAt datetime optional

nullable

invoiceId uuid optional

Wholesale invoice the charge has been bundled into.

nullable

paidAt datetime optional

nullable

refundedAt datetime optional

nullable

refundReason string optional

max 500 Zeichennullable

stripePaymentIntentId string optional

read-onlynullable

stripeChargeId string optional

nullable

stripeRefundId string optional

nullable

stripeAccountId string optional

MSP Stripe Connect account that received the destination charge.

nullable

notes string optional

max 2000 Zeichennullable

Voucher

course_vouchers4 Permissions

Single-use or limited-use voucher granting course access (ADR 0066b Phase 4)

code string erforderlich

Voucher code (uppercased ASCII alnum + dash/underscore).

4–32 ZeichenPatternread-only

courseId uuid erforderlich → course

shareId uuid erforderlich

course_shares row this voucher is bound to.

consumerTenantId string optional

PatternDefault: nullnullable

discountMode string optional

Werte

freefixed_off_centspercent_off

Default: "free"

discountValue integer optional

For fixed_off_cents: cents to subtract. For percent_off: 0..100. Ignored for free.

≥ 0Default: 0

maxRedemptions integer erforderlich

Total times the code may be redeemed across all users.

≥ 1Default: 1

redemptions integer optional

≥ 0Default: 0read-only

redeemedBy object[] optional

Default: []read-only

userId uuid erforderlich

tenantId uuid erforderlich

read-only

redeemedAt datetime erforderlich

enrollmentId uuid erforderlich

validFrom datetime optional

Default: nullnullable

validUntil datetime optional

Default: nullnullable

status string optional

Werte

activedepletedexpiredrevoked

Default: "active"

notes string optional

max 2000 Zeichennullable

course_shares4 Permissions

Cross-tenant sharing configuration for an academy course

courseId uuid erforderlich → course

Reference to a course in the sharing (MSP) tenant

recipientType string erforderlich

Type of recipient. Phase 1 of ADR 0066b only implements TENANT; TEAM/USER reserved.

Werte

TENANTTEAMUSER

recipientId uuid erforderlich

ID of the recipient tenant (or team/user in future phases)

pricingSnapshot object optional

Frozen pricing terms at the time of the share. Phase 1 stores the values; actual charging happens in Phase 2 (course_charges).

Default: {}

mode string optional

Pricing mode. Phase 1 supports free + fixed_per_seat.

Werte

freefixed_per_seat

Default: "free"

amountCents integer optional

Charge per enrollment in EUR cents (gross).

≥ 0Default: 0

currency string optional

Default: "EUR"

taxRatePercent number optional

0 – 100Default: 19

chargingMode string optional

wholesale: charge is bundled into the customer-tenant wholesale invoice (Phase 2). direct_stripe: customer pays in real-time via Stripe Connect on the MSP account (Phase 3).

Werte

wholesaledirect_stripe

Default: "wholesale"

publishToPublicCatalog boolean optional

If true, the course is listed on the MSP public catalog at /academy/:mspSlug. Anonymous users can browse and self-register via email-token flow.

Default: false

maxEnrollments integer optional

Optional cap on total enrollments via this share. Null = unlimited.

≥ 1Default: nullnullable

enrollmentDeadline datetime optional

Optional ISO date-time after which no further enrollments are allowed.

Default: nullnullable

allowSelfEnrollment boolean optional

If true, customer-tenant users can self-enroll; if false, only a customer-tenant manager may enroll others.

Default: true

requireManagerApproval boolean optional

If true, self-enrollments are pending until a customer-tenant manager approves them.

Default: false

shareSettings object optional

Per-share rendering and branding tweaks

Default: {}

showMspBranding boolean optional

Show the MSP-tenant logo on certificates and course pages.

Default: true

customLogo string optional

Optional file ID (in source tenant) to use as the course logo for this share.

PatternDefault: nullnullable

status string optional

Share lifecycle. Auto-paused when either tenant loses the required academy module.

Werte

activepausedrevoked

Default: "active"

createdBy uuid optional

User ID (in source tenant) who created the share.

read-only

updatedBy string optional

User ID who last updated the share.

Patternread-onlynullable

Custom-Endpoints (`/api/v1/lms-player/...`)

Der Lerner-Player bündelt eine Sicht zum Durchgehen eines Kurses:

Operation	Hinweis
`GET /api/v1/lms-player/courses/<courseId>/state`	Aktueller Stand des Lernenden
`POST /api/v1/lms-player/lessons/<id>/complete`	Lektion abgeschlossen markieren
`POST /api/v1/lms-player/quizzes/<id>/submit`	Quiz-Antworten einreichen, Ergebnis
`GET /api/v1/lms-player/certificates/<courseId>`	Zertifikat (PDF) holen

Analog zur KB-Cross-Tenant-Funktion gibt es course_shares. MSPs teilen Kurse mit Customer-Tenants. Customer-Tenants brauchen eine eigene Academy-Lizenz, um geteilte Kurse zu sehen.

Verwandt

Konventionen
HR & Payroll — Pflicht-Schulungen, Zertifikatsnachweise
Wissensdatenbank — Kurse können auf KB-Artikel verweisen

LMS

Resources

Schemas

Custom-Endpoints (/api/v1/lms-player/...)

Cross-Tenant-Sharing

Verwandt

Custom-Endpoints (`/api/v1/lms-player/...`)