Skip to main content

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

CapabilityBehaviorDependency
List by courseConfirms course then returns newest-first material metadataLocal store
Create/uploadValidates metadata, decodes request content, stores document, then saves local referenceDocument Service
DownloadResolves local material reference and streams dependency responseDocument Service
DeleteDeletes only the LMS reference; retained dependency content is explicitly recordedLocal 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.cs
  • microservices/src/training-service/Application/DocumentServiceClient.cs
  • microservices/src/training-service/Program.cs

See Also

Keywords

  • LMS API
  • Training Service
  • Source-backed contract

Revision Information

  • Status: Draft
  • Last reviewed: 2026-07-17
  • Review cycle: Quarterly