LMS Course Material API
Summary
Source-backed Draft reference for LMS Course Material API across the implemented Training Service and, where applicable, Gateway surface.
Audience
API consumers, engineering, QA, support, architecture, security, product, and implementation reviewers.
Reference Content
Operations
| Capability | Behavior | Dependency |
|---|---|---|
| List by course | Confirms course then returns newest-first material metadata | Local store |
| Create/upload | Validates metadata, decodes request content, stores document, then saves local reference | Document Service |
| Download | Resolves local material reference and streams dependency response | Document Service |
| Delete | Deletes only the LMS reference; retained dependency content is explicitly recorded | Local store |
The upload has no configured API-level size limit, extension allowlist, malware scanning, versioning, retention, or compensation if external storage succeeds and the later local save fails. Deletion does not remove the external document. Download and delete are identifier-based; no ownership policy is declared. Public documentation intentionally excludes document references, storage details, content, and internal dependency routes.
Dependency unavailability maps to 503 and missing dependency files map to 404. Local missing course/material/reference conditions map to 404.
Source References
microservices/src/training-service/Api/TrainingEndpoints.csmicroservices/src/training-service/Application/DocumentServiceClient.csmicroservices/src/training-service/Program.cs
Related Articles
See Also
Keywords
- LMS API
- Training Service
- Source-backed contract
Revision Information
- Status: Draft
- Last reviewed: 2026-07-17
- Review cycle: Quarterly