Assign a course

Módulo Workforce

POST/training-courses/{id}/assigntrainingCourses.assign

Assigns a published course to active members with an optional due date. 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.publish.
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.assign: 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: AssignTrainingRequest

trainingCourses.assign: AssignTrainingRequest
Campo	Tipo	Obligatorio	Descripción
membership_ids	array of string (uuid)	Sí	Learners.
due_on	string (date)	No	Due date.
reason	string	No	Why.Restricciones: length 0 to 300

{
  "membership_ids": [
    "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  ],
  "due_on": "2026-10-20",
  "reason": "New riggers"
}

Respuesta 200: AssignTrainingResult

trainingCourses.assign: AssignTrainingResult
Campo	Tipo	Obligatorio	Descripción
assigned	integer	Sí	Newly assigned learners.Restricciones: range 0 to any

{
  "assigned": 2
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/training-courses/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/assign" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"membership_ids":["0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"],"due_on":"2026-10-20","reason":"New riggers"}'

const { data } = await xos.trainingCourses.assign("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "membership_ids": [
      "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
    ],
    "due_on": "2026-10-20",
    "reason": "New riggers"
  });

response = xos.training_courses.assign("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"membership_ids": ["0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"], "due_on": "2026-10-20", "reason": "New riggers"})

xos training-courses assign 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"membership_ids":["0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"],"due_on":"2026-10-20","reason":"New riggers"}'