Alunos do contrato

Esta página descreve o endpoint da aba Alunos, da tela Contratos. A aba mostra os alunos vinculados ao contrato. Os alunos entram nela pela vinculação feita na conclusão do contrato, descrita em Contratos. A aba só tem conteúdo depois que o contrato é concluído, ou seja, quando ele está ativo, vencido ou cancelado.

Esta tela é somente para consulta: não há endpoint de edição de alunos do contrato.

Endpoints

Método	Caminho	Descrição
GET	/comercial/contracts/{contract_uuid}/students	Lista os alunos vinculados ao contrato

Consultar

GET /comercial/contracts/{contract_uuid}/students

Lista os alunos vinculados ao contrato. Cada item é uma matrícula de treinamento que está ligada a um dos cursos do contrato.

Parâmetros de URL

Parâmetro	Descrição
search	Texto livre: nome ou documento do aluno
columnName e orderData	Ordenação: nome da coluna e asc ou desc. Sem ordenação, a lista sai pelo nome do aluno

Resposta: lista. Campos principais: id, student_name, document, business_name (empresa), status_name (situação do treinamento do aluno), class (turma, com a modalidade), course (curso), customer_vendor_student (com a empresa do aluno), amount (valor), contract_course_id e contract_course (com o contrato) e os dados de criação e alteração.