Arquivos do instrutor
Documentos do instrutor, como contrato, exame e certificado, cada um classificado por
categoria. Correspondem à aba Arquivos, na tela Instrutores. Os endpoints são os
mesmos dos colaboradores, com {type} igual a instructors.
Use o uuid do instrutor nos caminhos abaixo. O {id} é o id numérico do arquivo.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/instructors/{uuid}/files | Lista os arquivos do instrutor |
| POST | /administrative/instructors/{uuid}/files | Anexa um arquivo |
| POST | /administrative/instructors/{uuid}/files/{id} | Substitui o arquivo ou os dados de um registro existente |
| GET | /administrative/instructors/{uuid}/files/{id} | Baixa o arquivo |
| DELETE | /administrative/instructors/{uuid}/files/{id} | Apaga o registro e o arquivo guardado |
| GET | /administrative/instructors/file-types | Lista as categorias de arquivo |
Endpoints de arquivos
GET /administrative/instructors/{uuid}/files
Lista os arquivos do instrutor.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Busca pela categoria do arquivo |
| columnName e orderData | Ordenação: coluna e direção |
| per_page e page | Paginação |
Resposta: 200, lista de arquivos com id, file_type_id, file_type (nome da
categoria), description, expiration_date, upload (dados do arquivo guardado) e os
nomes de quem criou e alterou o registro.
POST /administrative/instructors/{uuid}/files
POST /administrative/instructors/{uuid}/files/{id}
Anexa um arquivo ao instrutor. Envie em multipart/form-data. Com {id}, o arquivo do
registro é substituído pelo novo, quando um arquivo for enviado, e os demais campos são
atualizados.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| file | Sim na criação. Não na alteração | Arquivo | PDF, JPG, JPEG ou PNG |
| file_type_id | Sim | Inteiro | Id da categoria de arquivo. Deve existir |
| description | Não | Texto | Descrição. Se ficar em branco, a tela usa o nome do arquivo |
| expiration_date | Não | Data (AAAA-MM-DD) | Data de vencimento. É apenas informativa |
Resposta: 201 na criação, 200 na alteração, com o registro do arquivo.
GET /administrative/instructors/{uuid}/files/{id}
Baixa o arquivo guardado. Se o registro ou o arquivo não existir, a resposta é 404 com
{"success": false, "error": "File not found"}.
Resposta: 200, arquivo para download.
DELETE /administrative/instructors/{uuid}/files/{id}
Apaga o registro e o arquivo guardado. A exclusão é lógica no registro.
Resposta: 204 quando apagado, sem corpo. 404 se o registro não existir.
Categorias de arquivo
GET /administrative/instructors/file-types
Lista as categorias de arquivo cadastradas para o cliente.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Busca pelo nome da categoria |
| columnName e orderData | Ordenação: coluna e direção |
| per_page e page | Paginação |
Resposta: 200, lista com id, uuid e file_type (nome da categoria).