Arquivos da turma

Os documentos guardados para a turma, como documentos da turma e certificados armazenados. Na tela, ficam na aba Turmas > Arquivos da classe da página da turma. Cada arquivo pode estar ligado a um aluno. Os arquivos também podem ser enviados para assinatura digital.

Nas rotas desta página, {class_uuid} é o uuid da turma e {id} é o identificador numérico do arquivo.

Endpoints

Método	Caminho	Descrição
GET	/comercial/classes/{class_uuid}/files	Lista os arquivos da turma
POST	/comercial/classes/{class_uuid}/files/{id?}	Envia um arquivo para a turma, ou substitui o arquivo de um registro existente
GET	/comercial/classes/{class_uuid}/files/download-files	Baixa os arquivos da turma em um pacote ZIP
GET	/comercial/classes/{class_uuid}/files/{id}	Baixa o arquivo
DELETE	/comercial/classes/{class_uuid}/files/{id}	Remove o arquivo
GET	/comercial/classes/{class_uuid}/files/{id}/recipients	Lista os destinatários da assinatura do arquivo
PATCH	/comercial/classes/{class_uuid}/files/{id}/resend-link/{recipient_id?}	Reenvia o link de assinatura
PATCH	/comercial/classes/{class_uuid}/files/{uuid}/send-to-sign	Envia o documento para assinatura digital

Listar e enviar

GET /comercial/classes/{class_uuid}/files

Lista os arquivos da turma informada na URL. Sem ordenação informada, a lista sai por nome do aluno e depois por descrição.

Parâmetros de URL

Parâmetro	Descrição
search	Texto livre para buscar pelo nome do aluno
columnName e orderData	Ordena pela coluna informada, em asc ou desc
per_page e page	Paginação. Sem per_page, a resposta é a lista completa

Resposta: 200. Cada item traz a descrição, o aluno vinculado (quando houver), o arquivo armazenado (upload), o status da assinatura digital (quando o arquivo foi enviado para assinatura) e o nome de quem alterou por último.

POST /comercial/classes/{class_uuid}/files/{id?}

Envia um arquivo para a turma. Sem {id}, cria um novo arquivo. Com {id}, atualiza o registro existente: se um novo arquivo for enviado, ele substitui o anterior no armazenamento. A requisição usa multipart/form-data, com o arquivo no campo file.

Corpo

Campo	Obrigatório	Tipo	Descrição
file	Sim na inclusão	Arquivo	Arquivo PDF, JPG, JPEG ou PNG, enviado de uma vez. Não é necessário quando {id} é informado
description	Não	Texto	Descrição do arquivo
training_student_id	Não	Número	Id do aluno na turma ao qual o arquivo se refere
upload_id	Não	Número	Id de um arquivo já enviado, para vincular a este registro
student_certificate_id	Não	Número	Id do certificado do aluno, quando o arquivo é um certificado

Quando o espaço de armazenamento do cliente não é suficiente, a resposta é 507 com {"message": "Espaço insuficiente"}.

Resposta: 200 com {"message": "Arquivo salvo com sucesso", "data": {...}}, em que data é o registro do arquivo.

Baixar, apagar e assinatura digital

GET /comercial/classes/{class_uuid}/files/download-files

Gera um pacote ZIP com os arquivos da turma e devolve para download. Para baixar só alguns arquivos, informe os ids em file_ids, como uma lista.

Parâmetros de URL

Parâmetro	Descrição
file_ids	Lista de ids dos arquivos a incluir. Sem ela, entram todos os arquivos da turma

Resposta: 200 com o arquivo ZIP para download.

GET /comercial/classes/{class_uuid}/files/{id}

Baixa o arquivo enviado.

Resposta: 200 com o arquivo para download. Quando o registro não tem arquivo armazenado, a resposta é 204, sem corpo.

DELETE /comercial/classes/{class_uuid}/files/{id}

Remove o arquivo da turma. Se o arquivo não foi enviado para assinatura, o arquivo armazenado é apagado. Se foi enviado, o documento de assinatura vinculado é removido. A remoção do registro é lógica.

Resposta: 200, com corpo null.

GET /comercial/classes/{class_uuid}/files/{id}/recipients

Lista os destinatários da assinatura do arquivo. Disponível quando o arquivo foi enviado para assinatura.

Resposta: 200 com a lista de destinatários. Quando o arquivo não tem assinatura digital, 404 com {"message": "Arquivo ou assinatura digital não encontrado"}.

PATCH /comercial/classes/{class_uuid}/files/{id}/resend-link/{recipient_id?}

Reenvia o link de assinatura aos destinatários do arquivo. Com {recipient_id}, o link vai só para esse destinatário. Sem ele, o link vai para todos os destinatários que têm link. O reenvio só é aceito quando a assinatura está em um status que permite reenvio.

Resposta: 200 com {"message": "Links reenviados com sucesso"}. Quando o arquivo não tem assinatura digital, 404. Quando a assinatura não está em um status que aceita reenvio, 400.

PATCH /comercial/classes/{class_uuid}/files/{uuid}/send-to-sign

Envia para assinatura digital o documento de assinatura identificado por {uuid}. O documento precisa estar ainda não enviado e ter pelo menos um destinatário.

Resposta: o retorno da assinatura digital. Quando o documento não pode ser enviado, 400 com a mensagem do motivo.

Listas auxiliares

Esta página não tem listas de apoio.