Complete a course

Módulo Workforce

POST/training-courses/{id}/completetrainingCourses.complete

Grades the caller's quiz answers once every reading and video lesson is finished. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad knowledge.sop.acknowledge.
Alcances de OAuth: knowledge.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

trainingCourses.complete: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the training course.

Cuerpo de la solicitud: CompleteTrainingRequest

trainingCourses.complete: CompleteTrainingRequest
Campo	Tipo	Obligatorio	Descripción
answers	object	Sí	Option numbers keyed by question id.

{
  "answers": {
    "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f": 1
  }
}

Respuesta 200: TrainingCompletion

trainingCourses.complete: TrainingCompletion
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the training completion.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Person who last updated the row; null for seed, platform or system writes.
training_course_id	string (uuid)	Sí	Identifier of the course.
membership_id	string (uuid)	Sí	Identifier of the learner.
score_percent	integer \| null	Sí	Quiz score in percent.Restricciones: range 0 to any
passed	boolean	Sí	Whether the attempt passed.
completed_at	string (date-time)	Sí	When the attempt finished.
expires_at	string (date-time) \| null	Sí	When the pass stops being current.
certificate_number	string \| null	Sí	Completion certificate number.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
certification_holder_id	string (uuid) \| null	Sí	Identifier of the certification record a verifier issued.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "training_course_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "score_percent": 90,
  "passed": true,
  "completed_at": "2026-10-08T14:30:00Z",
  "expires_at": "2026-10-08T14:30:00Z",
  "certificate_number": "TRN-0001",
  "certification_holder_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/training-courses/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/complete" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"answers":{"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f":1}}'

const { data } = await xos.trainingCourses.complete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "answers": {
      "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f": 1
    }
  });

response = xos.training_courses.complete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"answers": {"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f": 1}})

xos training-courses complete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"answers":{"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f":1}}'