LMS API Documentation

Summary

This Draft section documents the implemented Learning Management System HTTP surface: 47 Training Service operations and two Gateway employee-self-service operations. The native surface is ASP.NET Core 8 minimal API code. Its maturity is Transitional because broad workflows exist without service-local authentication, endpoint authorization, resource ownership enforcement, pagination, versioning, or a uniform error contract.

Audience

API consumers, engineering, QA, support, architecture, security, product, and implementation reviewers.

Overview

The section separates native Training operations from Gateway-owned employee-self-service composition and records only route, contract, validation, context, dependency, diagnostic, discovery, and test behavior verified in source.

Documentation map

1. API overview
2. Route and endpoint map
3. Authentication and request context
4. Tenant and actor context
5. Request and response models
6. Validation and error handling
7. Capability pages from Course API through Dashboard API
8. Integration, diagnostics, discovery, testing, limitations, and the endpoint catalog

Verified surface

Classification	Operations	Evidence
Native Training Service	47	Two service-level routes plus 45 operations under the Training route group
Gateway LMS/ESS	2	One LMS proxy and one multi-module dashboard composition
Read / write	31 / 18	All Gateway LMS operations are reads
Import/export	8	Two templates, two imports, and four exports
Reports	7	Dashboard, five domain reports, and one subject-scoped report
Direct document transfer	3	One material upload-style request and two binary downloads
File responses	8	Six CSV responses and two binary downloads

The native and Gateway classifications are not interchangeable. Gateway responses wrap or compose downstream results; native endpoints return DTOs, projections, messages, files, or diagnostic entities directly.

Requires confirmation

Authorization ownership, public diagnostic exposure, employee self-ownership, response redaction, contract governance, pagination, versioning, and production OpenAPI exposure require confirmation.

Source References

• microservices/src/training-service/Program.cs
• microservices/src/training-service/Api/TrainingEndpoints.cs
• microservices/src/gateway-api/EssEndpoints.cs
• microservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.cs
• microservices/scripts/smoke-training.ps1

Related Articles

• LMS module
• LMS technical documentation
• API limitations

See Also

• Route and endpoint map
• Endpoint catalog

Keywords

• LMS API
• Training Service
• Gateway ESS

Revision Information

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