API de paquetes

Lista los paquetes con sus cursos. Un cliente de organización ve los paquetes de su organización; un cliente de grupo solo ve los paquetes vinculados a su grupo.

Listar paquetes

GET /api/v1/packages

Ámbito requerido: training.read. Consulta Autenticación para obtener un token de acceso.

curl --request GET \
  --url "https://courses.e-learningcourses.com/api/v1/packages?page=1&pageSize=1000&includeArchived=false" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "Accept: application/json"

Parámetros de consulta

Parámetro	Tipo	Predeterminado	Descripción
page	entero	1	Número de página, a partir de 1.
pageSize	entero	1000	Paquetes por página, entre 1 y 5000.
includeArchived	booleano	false	Usa true para incluir paquetes archivados.

Respuesta

{
  "data": [
    {
      "packageId": "46647b28-2785-4435-9fa9-715e8c461902",
      "name": "Cumplimiento de proveedores",
      "type": "standard",
      "archived": false,
      "courses": [
        {
          "courseId": "38f595b7-2ff4-4da6-bf24-91316399ec9a",
          "name": "Código de conducta para proveedores"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1000,
    "totalRecords": 1,
    "totalPages": 1
  }
}

Campo	Tipo	Descripción
packageId	UUID	Identificador del paquete.
name	cadena	Nombre del paquete.
type	cadena	standard o versioned. Un paquete versionado contiene versiones sucesivas de un curso, por lo que un alumno puede tener registros de formación para varios de sus cursos.
archived	booleano	Indica si el paquete está archivado.
courses	array	Cursos vinculados actualmente al paquete. Puede estar vacío.
courses[].courseId	UUID	Identificador del curso. Coincide con courseId en los registros de formación y los certificados.
courses[].name	cadena	Nombre del curso.

Los paquetes se ordenan por nombre y luego por packageId. El objeto pagination cuenta los paquetes después de aplicar includeArchived, no los cursos que contienen. Si no hay resultados, data está vacío y totalPages vale 0.

Errores

Una paginación no válida devuelve 400 en formato Problem Details. Si falta el token o ha caducado, se devuelve 401; si falta el ámbito o el cliente ha perdido el acceso, se devuelve 403. El límite compartido puede devolver 429. Consulta Autenticación para conocer los límites y cómo reintentar.

OpenAPI

https://courses.e-learningcourses.com/api/v1/openapi.json