Arquivos da turma

Arquivos da turma são os documentos (PDF ou imagem) guardados junto à turma e, opcionalmente, ligados a um aluno da turma. Esta página cobre a listagem e o envio desses arquivos, e a listagem dos arquivos cadastrados para os alunos da turma.

No manual de usuário, esta área é a aba Arquivos da classe, dentro do detalhe da turma (módulo Operacional). Na tela, a listagem é para consulta.

As regras gerais estão em Convenções e a sessão em Autenticação. Os dados da turma estão em Turmas.

Endpoints

Método	Caminho	Descrição
GET	/operational/classes/{class_uuid}/files	Lista os arquivos ligados à turma
POST	/operational/classes/{class_uuid}/files	Envia um arquivo para a turma
GET	/operational/classes/{class_uuid}/students-files	Lista os arquivos cadastrados para os alunos da turma

Listar arquivos da turma

GET /operational/classes/{class_uuid}/files

Lista os arquivos ligados à turma informada. Cada item traz a descrição, o aluno a que o arquivo está ligado (quando houver), os dados do arquivo enviado e, quando o arquivo foi assinado digitalmente, a situação da assinatura.

Parâmetros de URL

Parâmetro	Descrição
search	Busca no nome do aluno ligado ao arquivo
columnName	Coluna de ordenação, com orderData
orderData	Sentido da ordenação: asc ou desc
per_page	Quantidade por página. Se omitido, a lista vem completa
page	Número da página, com per_page

Sem ordenação informada, a lista vem por nome do aluno e depois pela descrição.

Resposta

• 200: lista de arquivos ou, com per_page, objeto paginado (veja Convenções).

Campos principais: id, description, training_student_id, name (nome do aluno), student_document, student_passport, upload (dados do arquivo enviado), digitalSignature (situação da assinatura digital, quando houver), user_update_name, created_at e updated_at.

Exemplo

curl "https://api.pedagogo.app/operational/classes/<uuid-da-turma>/files?per_page=15" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

Enviar arquivo

POST /operational/classes/{class_uuid}/files

Envia um arquivo e o liga à turma. O envio usa multipart/form-data. Os tipos aceitos são PDF, JPG, JPEG e PNG. O espaço de armazenamento disponível para a empresa cliente é verificado antes do envio.

Corpo (multipart/form-data)

Campo	Obrigatório	Tipo	Descrição
file	Sim	arquivo	Arquivo a enviar: PDF, JPG, JPEG ou PNG
description	Não	texto	Descrição do arquivo
training_student_id	Não	inteiro	Matrícula do aluno à qual o arquivo se liga (identificador da matrícula na turma)

Resposta

• 201: lista com dois itens: o objeto {"message": "Arquivo salvo com sucesso", "data": { ... }}, com os dados do arquivo criado, e o código 200.
• 201: quando não há espaço de armazenamento, a lista traz {"message": "Espaço insuficiente"} e o código 507 no corpo.
• 422: dados inválidos (por exemplo, tipo de arquivo não aceito).

Exemplo

curl -X POST https://api.pedagogo.app/operational/classes/<uuid-da-turma>/files \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -F "[email protected]" \
  -F "description=Lista de presenca assinada"

Arquivos dos alunos

GET /operational/classes/{class_uuid}/students-files

Lista os arquivos do cadastro de cada aluno matriculado na turma. Cada item traz o tipo de arquivo, a validade, a descrição e os dados do arquivo enviado.

Parâmetros de URL

Parâmetro	Descrição
search	Busca no nome do tipo de arquivo
columnName	Coluna de ordenação, com orderData
orderData	Sentido da ordenação: asc ou desc
per_page	Quantidade por página
page	Número da página, com per_page

Resposta: lista de arquivos, com id, customer_vendor_id, file_type_id, file_type, matrix, upload_id, upload (dados do arquivo enviado), description, expiration_date, updated_at, user_create_name e user_update_name.

• 200: lista de arquivos ou, com per_page, objeto paginado.