Skip to main content

LMS Request and Response Models

Summary​

Source-backed Draft reference for LMS Request and Response Models across the implemented Training Service and, where applicable, Gateway surface.

Audience​

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

Reference Content​

Confirmed named HTTP types​

The endpoint file defines 32 named HTTP-facing types: 16 request DTOs (13 top-level operation inputs plus three nested content/question inputs) and 16 response/support types (eight resource DTOs, six report DTOs, one import result, and one nested import row error). The same file also emits anonymous projections, message objects, collections, CSV/binary files, and diagnostic entity collections.

ClassNamed typesConceptual contentSensitive handling
Course/content/path requests4Course identity/content, nested modules/lessons, ordered course referencesPublic docs omit content values and internal identifiers
Enrollment/assessment/attempt requests6Assignment, completion input, assessment/question definition, attempt start/submissionPersonal references, answer material, and result values are not reproduced
Certificate/material/session requests5Issue/generation, file transfer metadata, scheduling/reschedulingCertificate, document, and recipient values are excluded
Import request1CSV text body used by both import routesNo sample personnel data
Import response/support2Aggregate import outcome and nested row errorNo sample personnel data
Resource responses8Course, path, enrollment, assessment, attempt, certificate, material, sessionPersonal learning/result/document values are excluded
Report responses6Aggregate course, enrollment, assessment, certificate, path, and subject summaryFields documented conceptually only

Shape behavior​

Required/optional behavior comes from C# constructor nullability plus endpoint/domain validation, not DataAnnotations or a validator library. Collections return JSON arrays. Dashboard and health data are anonymous objects. Explicit failures return anonymous message objects. File endpoints return CSV or binary results. Service information alone uses the shared response envelope.

The source also returns audit, timeline, and outbox entity projections directly. That public exposure and redaction boundary require confirmation.

Endpoint use​

See the endpoint catalog for the request/response type attached to each operation and validation for runtime checks.

Source References​

  • microservices/src/training-service/Api/TrainingEndpoints.cs
  • microservices/src/training-service/Domain/TrainingEntities.cs
  • microservices/src/contracts/Common/ApiResponse.cs

See Also​

Keywords​

  • LMS API
  • Training Service
  • Source-backed contract

Revision Information​

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