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

Certificate Schema

Schema-ID
certificate
Collection
certificates
Permissions
  • Lesencertificate_view
  • Anlegencertificate_create
  • Änderncertificate_edit
  • Löschencertificate_delete
Beziehungen

Felder

Certificate Schema

certificates4 Permissions

Schema for validating completion certificates in the Academy/LMS module

courseIdstringerforderlich

ID of the completed course

min 1 Zeichen
userIdstringerforderlich

ID of the student who earned the certificate

min 1 Zeichen
enrollmentIdstringerforderlich

ID of the enrollment record

min 1 Zeichen
certificateNumberstringerforderlich

Unique certificate number

min 1 Zeichenread-only
issuedAtdatetimeerforderlich

Date and time when the certificate was issued

validUntildatetimeoptional

Certificate expiration date (if applicable)

nullable
templateIdstringoptional

ID of the certificate template used

nullable
consumerTenantIdstringoptional

Tenant the learner belongs to. Null for MSP-internal certificates; set for cross-tenant.

nullable
metadataobjecterforderlich
courseNamestringerforderlich

Name of the completed course

min 1 Zeichen
studentNamestringerforderlich

Name of the student who completed the course

min 1 Zeichen
instructorNamestringoptional

Name of the course instructor

nullable
completionDatedatetimeerforderlich

Date when the course was completed

gradestringoptional

Grade or performance rating

nullable
hoursnumbererforderlich

Total course hours for certification

≥ 0

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

Suche