Aulas práticas

Os endpoints desta página atendem a tela Aulas práticas. Uma aula prática é uma sessão de treinamento prático vinculada a um curso, com data de início e de término, local de treinamento e os alunos que participam. Os alunos da aula têm páginas próprias, em Alunos da aula prática.

Endpoints

Método	Caminho	Descrição
GET	/comercial/practical-classes	Lista as aulas práticas do cliente.
POST	/comercial/practical-classes	Cria uma aula prática.
GET	/comercial/practical-classes/{uuid}	Consulta uma aula prática, com o curso e os alunos.
PUT	/comercial/practical-classes/{uuid}	Altera uma aula prática.
DELETE	/comercial/practical-classes/{uuid}	Apaga uma aula prática.
GET	/comercial/practical-classes/{uuid}/attendance-record	Gera o PDF da lista de presença da aula.
GET	/comercial/practical-classes/courses	Lista de apoio: cursos com carga prática.
GET	/comercial/practical-classes/locations	Lista de apoio: locais de treinamento.
GET	/comercial/practical-classes/students/status	Lista de apoio: status de aluno.
GET	/comercial/practical-classes/students/practices	Lista de apoio: aulas práticas (mesma resposta da listagem).

Aulas práticas

GET /comercial/practical-classes

Lista as aulas práticas do cliente. Sem per_page, a resposta é a lista direta. Com per_page, a resposta vem paginada, como descrito em Convenções.

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
search	Não	Texto livre: busca pelo nome ou pela sigla do curso, pelo nome do curso e pelo nome do local.
column	Não	Coluna usada na ordenação. Usada junto com order.
order	Não	Sentido da ordenação, como asc ou desc. Usado junto com column.
per_page	Não	Quantidade de registros por página.
page	Não	Número da página, quando per_page é informado.

Resposta

200, com a lista de aulas práticas. Campos principais: uuid, course_uuid, course_name, course_code, workload, start_date, end_date, location_name, status_name, observations, user_create_name e user_update_name.

Exemplo:

curl -G "https://api.pedagogo.app/comercial/practical-classes" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data-urlencode "search=Curso exemplo" \
  --data-urlencode "per_page=15"

POST /comercial/practical-classes

Cria uma aula prática. O servidor gera o uuid, associa a aula ao cliente da sessão e registra o usuário que criou o registro.

Corpo

Campo	Obrigatório	Tipo	Descrição
course_uuid	Sim	Texto (uuid)	uuid do curso ao qual a aula pertence. O curso precisa existir.
start_date	Sim	Data	Primeiro dia da aula prática.
end_date	Sim	Data	Último dia da aula prática.
location_id	Não	Número	id do local de treinamento. O local precisa existir. Os locais vêm de GET /comercial/practical-classes/locations.
observations	Não	Texto	Observações sobre a aula.

Resposta

200, com o registro criado, incluindo o uuid.

Exemplo:

curl -X POST "https://api.pedagogo.app/comercial/practical-classes" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "course_uuid": "<uuid-do-curso>",
    "start_date": "2026-03-10",
    "end_date": "2026-03-12",
    "location_id": 1,
    "observations": "Aula prática exemplo"
  }'

GET /comercial/practical-classes/{uuid}

Devolve a aula prática identificada por {uuid}, com o objeto do curso e a lista de alunos da aula (practiceStudents). Os alunos seguem o formato de Alunos da aula prática.

PUT /comercial/practical-classes/{uuid}

Altera a aula prática identificada por {uuid}. O corpo segue as mesmas regras da criação.

Corpo

Campo	Obrigatório	Tipo	Descrição
course_uuid	Sim	Texto (uuid)	uuid do curso. O curso precisa existir.
start_date	Sim	Data	Primeiro dia da aula prática.
end_date	Sim	Data	Último dia da aula prática.
location_id	Não	Número	id do local de treinamento. O local precisa existir.
observations	Não	Texto	Observações sobre a aula.

Resposta

200, com o registro alterado.

DELETE /comercial/practical-classes/{uuid}

Apaga a aula prática identificada por {uuid}. A exclusão é lógica: a aula deixa de aparecer nas listagens. A resposta é 200, sem corpo.

GET /comercial/practical-classes/{uuid}/attendance-record

Gera a lista de presença da aula em PDF. O arquivo vem como download direto, na resposta 200, com as datas da aula entre o início e o término. O arquivo temporário é apagado depois do envio. Não há outro parâmetro além do uuid.

Listas auxiliares

• courses: cursos com carga prática, ou seja, cursos com carga horária prática maior que zero. Use o uuid como course_uuid.
• locations: locais de treinamento do cliente, com id e name. Use o id como location_id.
• students/status: lista fixa de status de aluno, com id e status. Os status são: Matriculado, Confirmado, Aprovado, Reprovado, Não concluído, Ausente e Cancelado. Use o id como status_id nos alunos da aula.
• students/practices: devolve a mesma lista da listagem de aulas práticas, com os mesmos parâmetros.