API de Pacotes

Lista os pacotes com seus cursos. Um cliente da organização vê os pacotes da sua organização; um cliente de grupo vê apenas os pacotes vinculados ao seu grupo.

Listar pacotes

GET /api/v1/packages

Escopo obrigatório: training.read. Consulte Autenticação para obter um token de acesso.

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	Padrão	Descrição
page	inteiro	1	Número da página, a partir de 1.
pageSize	inteiro	1000	Pacotes por página, de 1 a 5000.
includeArchived	booleano	false	Use true para incluir pacotes arquivados.

Resposta

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

Campo	Tipo	Descrição
packageId	UUID	Identificador do pacote.
name	string	Nome do pacote.
type	string	standard ou versioned. Um pacote versionado contém versões sucessivas de um curso, então um aluno pode ter registros de treinamento para mais de um de seus cursos.
archived	booleano	Indica se o pacote está arquivado.
courses	array	Cursos atualmente vinculados ao pacote. Pode estar vazio.
courses[].courseId	UUID	Identificador do curso. Corresponde ao courseId dos registros de treinamento e dos certificados.
courses[].name	string	Nome do curso.

Os pacotes são ordenados por nome e depois por packageId. O objeto pagination conta os pacotes após aplicar includeArchived, não os cursos contidos neles. Quando não há resultados, data está vazio e totalPages é 0.

Erros

Paginação inválida retorna 400 no formato Problem Details. Token ausente ou expirado retorna 401; escopo insuficiente ou perda de acesso do cliente retorna 403. O limite compartilhado pode retornar 429. Consulte Autenticação para conhecer os limites e as orientações de nova tentativa.

OpenAPI

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