Arquivos do aluno
Corresponde à aba Arquivos, na página de um aluno. Guarda os documentos
digitalizados do aluno, como RG, comprovantes e laudos. Cada arquivo é classificado
por uma categoria, cadastrada em Configurações. A lista de
categorias para escolher está em GET /administrative/students/file-types, descrita
na página Alunos.
Todos os endpoints desta página começam pelo uuid do aluno,
customer_vendor_student_uuid.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/students/{customer_vendor_student_uuid}/files | Lista os arquivos do aluno |
| POST | /administrative/students/{customer_vendor_student_uuid}/files/{id?} | Anexa um arquivo ao aluno, ou altera um arquivo já anexado quando id é informado |
| GET | /administrative/students/{customer_vendor_student_uuid}/files/{id} | Baixa um arquivo do aluno |
| DELETE | /administrative/students/{customer_vendor_student_uuid}/files/{id} | Apaga um arquivo do aluno |
GET /administrative/students/{customer_vendor_student_uuid}/files
Lista os arquivos do aluno.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Texto livre que busca no nome da categoria do arquivo |
| columnName | Coluna para ordenar |
| orderData | Sentido da ordenação: asc ou desc |
| per_page | Quantidade de registros por página |
| page | Número da página, quando per_page é informado |
Resposta (200): lista de arquivos, direta ou paginada. Campos principais:
id, customer_vendor_id, file_type_id, file_type (nome da categoria),
description, expiration_date, upload_id, upload (dados do arquivo enviado),
user_create_name e user_update_name.
POST /administrative/students/{customer_vendor_student_uuid}/files/{id?}
Anexa um arquivo ao aluno. Sem id na URL, cria um novo arquivo. Com id,
altera o arquivo existente: a descrição, a categoria e a data são atualizadas, e o
arquivo só é trocado se um novo for enviado. Ao trocar o arquivo, o anterior é
substituído.
Aceita os formatos PDF, JPG, JPEG e PNG.
Corpo (multipart/form-data)
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| file | Sim na criação; Não na alteração | Arquivo (PDF, JPG, JPEG ou PNG) | Arquivo a ser anexado |
| file_type_id | Sim | Número inteiro | id da categoria do arquivo |
| description | Não | Texto | Descrição do arquivo |
| expiration_date | Não | Data (AAAA-MM-DD) | Data de vencimento do documento. É apenas informativa |
Resposta (201): o registro do arquivo criado ou alterado.
GET /administrative/students/{customer_vendor_student_uuid}/files/{id}
Baixa o arquivo anexado.
Resposta (200): arquivo para download. Se o registro não tiver arquivo anexado, a resposta é 204, sem conteúdo.
DELETE /administrative/students/{customer_vendor_student_uuid}/files/{id}
Remove o registro do arquivo e apaga o arquivo guardado.
Resposta (200): sem conteúdo relevante (null).
Regras
- Não há alerta automático para documentos vencidos. A data de vencimento é apenas informativa.