LMS Document Integration API
Summary
Source-backed Draft reference for LMS Document Integration 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
Training operations using Document Service
| LMS capability | Request/response | Local transaction relationship | Failure mapping |
|---|---|---|---|
| Material creation | Material upload DTO to material DTO | External store completes before local reference save | Dependency unavailable 503 |
| Material download | Identifier to file response | Read-only local lookup then external download | Missing local/reference/file 404; unavailable 503 |
| Certificate generation | Optional generation DTO to certificate DTO | External store completes before local certificate update | Invalid lifecycle 409; missing local 404; unavailable 503 |
| Certificate download | Identifier to file response | Read-only local lookup then external download | Missing local/reference/file 404; unavailable 503 |
All local queries remain tenant-filtered, and create/generate require tenant context. No endpoint authorization is declared. There is no distributed transaction, compensation, orphan cleanup, versioning, retention synchronization, or dependency-specific health probe. Material reference deletion intentionally retains external content.
Internal dependency routes, hosts, configuration, storage references, and document values are excluded.
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