Alunos da aula prática

Os endpoints desta página atendem a aba Alunos, na página de uma aula prática. Ela registra quais alunos do treinamento participam da prática, com o status de cada um na parte prática e observações.

O status informado aqui não altera o status do aluno no treinamento. O resultado da prática fica registrado nesta aba. O aluno é identificado pelo uuid da matrícula no treinamento, e a aula, pelo uuid da aula prática ({practice_uuid}).

Endpoints

Método	Caminho	Descrição
GET	/comercial/practical-classes/{practice_uuid}/students	Lista os alunos da aula prática.
POST	/comercial/practical-classes/{practice_uuid}/students	Inclui um aluno na aula prática.
GET	/comercial/practical-classes/{practice_uuid}/students/{id}	Consulta um aluno da aula prática.
PUT	/comercial/practical-classes/{practice_uuid}/students/{id}	Altera o status ou as observações de um aluno da aula.
DELETE	/comercial/practical-classes/{practice_uuid}/students/{id}	Remove um aluno da aula prática.
GET	/comercial/practical-classes/{practice_uuid}/training-students	Lista de apoio: alunos do treinamento que podem participar da aula.

Alunos da aula

GET /comercial/practical-classes/{practice_uuid}/students

Lista os alunos da aula prática. 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 do aluno.
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 alunos da aula. Campos principais: id, student_uuid, student_name, student_document, class_code, start_date, end_date, status_student, status_practical_class, observations, user_create_name e user_update_name.

• status_student é o status do aluno no treinamento.
• status_practical_class é o status do aluno na parte prática.

POST /comercial/practical-classes/{practice_uuid}/students

Inclui um aluno na aula prática. O aluno precisa estar matriculado no treinamento, em turma ou como aluno online.

Corpo

Campo	Obrigatório	Tipo	Descrição
student_uuid	Sim	Texto (uuid)	uuid da matrícula do aluno no treinamento. A matrícula precisa existir.
status_id	Não	Número	id do status da prática. Os valores vêm de GET /comercial/practical-classes/students/status.

Resposta

200, com o registro criado. O id devolvido é o número usado nas rotas de consulta, alteração e remoção deste aluno.

Exemplo:

curl -X POST "https://api.pedagogo.app/comercial/practical-classes/<uuid-da-aula>/students" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "student_uuid": "<uuid-da-matricula>",
    "status_id": 1
  }'

Consultar, alterar e apagar

GET /comercial/practical-classes/{practice_uuid}/students/{id}

Devolve o aluno da aula identificado por {id}, com os campos da listagem.

PUT /comercial/practical-classes/{practice_uuid}/students/{id}

Altera o aluno da aula identificado por {id}.

Corpo

Campo	Obrigatório	Tipo	Descrição
student_uuid	Sim	Texto (uuid)	uuid da matrícula do aluno no treinamento.
status_id	Não	Número	id do status da prática.

Resposta

200, com o registro alterado.

DELETE /comercial/practical-classes/{practice_uuid}/students/{id}

Remove o aluno da aula prática identificado por {id}. A exclusão é lógica: o aluno deixa de aparecer na listagem da aula. A resposta é 200, sem corpo.

Listas auxiliares

• {practice_uuid}/training-students: alunos do treinamento que podem participar da aula. Devolve as matrículas do curso da aula prática, somente quando esse curso tem carga prática. Aceita o parâmetro search, que busca por dados do aluno, do curso e da empresa, e per_page e page, para paginação. Use o uuid de cada item como student_uuid.