Treinamentos do aluno
Corresponde à aba Treinamentos, na página de um aluno. Mostra os treinamentos que o aluno fez ou está fazendo. Também é daqui que saem o recibo de pagamento, o Excel dos treinamentos e o envio de certificados para o aluno.
Todos os endpoints desta página começam pelo uuid do aluno,
customer_vendor_student_uuid.
Os envios de certificado (e-mail e WhatsApp) são feitos na hora da chamada. Eles consideram os treinamentos sem empresa vinculada, ou seja, os pagos pelo próprio aluno. Os certificados de treinamentos contratados por uma empresa são enviados pela tela Turmas, fora deste módulo.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/students/{customer_vendor_student_uuid}/trainings | Lista os treinamentos do aluno |
| GET | /administrative/students/{customer_vendor_student_uuid}/trainings/excel | Baixa a lista de treinamentos em planilha |
| GET | /administrative/students/{customer_vendor_student_uuid}/trainings/payment-receipt | Gera o recibo de pagamento dos treinamentos selecionados |
| GET | /administrative/students/{customer_vendor_student_uuid}/trainings/show-certificates | Gera o PDF com os certificados do aluno |
| GET | /administrative/students/{customer_vendor_student_uuid}/trainings/send-certificates-by-email | Envia os certificados ao e-mail do aluno |
| GET | /administrative/students/{customer_vendor_student_uuid}/trainings/send-certificates-by-whatsapp | Envia os certificados ao celular do aluno |
GET /administrative/students/{customer_vendor_student_uuid}/trainings
Lista os treinamentos do aluno, do mais recente para o mais antigo pela data de
início, salvo se column e order forem informados.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Texto livre: busca pelo nome do aluno, CPF, celular, e-mail, nome e sigla do curso e nome ou CNPJ da empresa |
| class_uuid | Traz só os treinamentos da turma com esse uuid |
| course_id | Traz só os treinamentos do curso com esse id |
| training_uuids | Lista de uuid de treinamentos, separados por vírgula |
| column | Coluna para ordenar |
| order | Sentido da ordenação: asc ou desc |
| limit | Quantidade máxima de registros, sem paginação |
| per_page | Quantidade de registros por página |
| page | Número da página, quando per_page é informado |
Resposta (200): lista de treinamentos. Campos principais: uuid do
treinamento, start_date, end_date, amount (valor), status_name (situação),
customer_vendor_student_uuid, course_name, course_code, class_code (código
da turma) e os dados da empresa vinculada, quando houver.
Exemplo:
curl "https://api.pedagogo.app/administrative/students/<uuid-do-aluno>/trainings?per_page=15" \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>"
GET /administrative/students/{customer_vendor_student_uuid}/trainings/excel
Baixa uma planilha Excel (.xlsx) com os treinamentos do aluno. Aceita os mesmos
parâmetros da listagem e exporta o resultado da busca.
Resposta (200): arquivo .xlsx para download.
GET /administrative/students/{customer_vendor_student_uuid}/trainings/payment-receipt
Gera o recibo de pagamento em PDF dos treinamentos informados. O recibo traz o nome do aluno, o CPF parcialmente oculto, o valor total, a lista dos treinamentos e a dos pagamentos.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| uuids | Sim | Lista de uuid dos treinamentos do aluno. Envie como uuids[]=... |
Resposta (200): arquivo PDF para download.
GET /administrative/students/{customer_vendor_student_uuid}/trainings/show-certificates
Gera um PDF com os certificados do aluno, dos treinamentos sem empresa vinculada.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| id | Não | id de um certificado. Se informado, o PDF traz só esse certificado |
Resposta (200): arquivo PDF para download.
GET /administrative/students/{customer_vendor_student_uuid}/trainings/send-certificates-by-email
Envia ao e-mail cadastrado no aluno o PDF com os certificados. Sem e-mail cadastrado, o envio não acontece.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| id | Não | id de um certificado. Se informado, envia só esse certificado |
Resposta (200):
{
"message": "Email enviado com sucesso",
"success": true
}
GET /administrative/students/{customer_vendor_student_uuid}/trainings/send-certificates-by-whatsapp
Envia ao celular cadastrado no aluno uma mensagem de texto e, em seguida, o PDF com os certificados. Sem celular cadastrado, o envio não acontece.
Parâmetros de URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| id | Não | id de um certificado. Se informado, envia só esse certificado |
Resposta (200):
{
"message": "Mensaje enviado com sucesso",
"success": true
}
Se o PDF não puder ser gerado, a resposta é 500, com "success": false.