Complementos do aluno online
Informações complementares de uma matrícula online: solicitante, informação adicional para o certificado e comentários, além de local e observações financeiras. Na tela, esses campos aparecem no formulário de Alunos online, como Solicitante, Informação adicional para o certificado e Comentários.
Os complementos são criados junto com a matrícula: ao cadastrar a matrícula, o sistema cria o registro de complementos; ao alterar, atualiza o registro existente ou cria um, se ainda não houver. Por isso não há rota de criação nesta página. Use POST e PUT da matrícula (ver Alunos online).
Todas as rotas usam o uuid da matrícula no caminho: {student_uuid}.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
GET | /comercial/online-students/{student_uuid}/complements | Lista os complementos da matrícula |
GET | /comercial/online-students/{student_uuid}/complements/{id} | Consulta um complemento |
PUT | /comercial/online-students/{student_uuid}/complements/{id} | Altera um complemento |
DELETE | /comercial/online-students/{student_uuid}/complements/{id} | Exclui um complemento |
Consulta
GET /comercial/online-students/{student_uuid}/complements
Lista os complementos da matrícula.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
column e order | Coluna e sentido da ordenação |
per_page e page | Paginação |
Resposta: 200. Sem per_page, a resposta é uma lista simples. Com per_page, a resposta é paginada. Cada item traz os campos do complemento e os nomes de quem criou e de quem alterou (user_create_name, user_update_name).
GET /comercial/online-students/{student_uuid}/complements/{id}
Devolve um complemento da matrícula.
Resposta: 200, com o complemento.
Alteração e exclusão
PUT /comercial/online-students/{student_uuid}/complements/{id}
Altera um complemento. Todos os campos são opcionais: só são alterados os enviados.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
requester | Não | texto | Solicitante |
certificate_text | Não | texto | Informação adicional para o certificado |
comments | Não | texto | Comentários |
location | Não | texto | Local |
financial_observations | Não | texto | Observações financeiras |
Resposta: 200, com o complemento alterado.
DELETE /comercial/online-students/{student_uuid}/complements/{id}
Exclui um complemento da matrícula.
Resposta: 200, sem corpo.