Complementos do curso
Esta página descreve os endpoints da aba Complementos do curso, da tela Cursos. Cada curso tem um único registro de complementos, que guarda o certificado, o layout, a fonte e os textos que saem no certificado e nos documentos do curso (norma, público-alvo, metodologia e pré-requisitos). O registro é criado junto com o curso.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /comercial/courses/{course_uuid}/complements | Lista o registro de complementos do curso |
| POST | /comercial/courses/{course_uuid}/complements | Cria o registro, ou atualiza o existente |
| PUT | /comercial/courses/{course_uuid}/complements/{id} | Altera o registro de complementos |
| DELETE | /comercial/courses/{course_uuid}/complements/{id} | Apaga o registro (exclusão lógica) |
Consultar, criar e alterar
GET /comercial/courses/{course_uuid}/complements
Lista os complementos do curso. Como cada curso tem um único registro, a lista traz um item.
Parâmetros de URL: column e order para ordenação.
Resposta: lista. Campos principais: id, course_id, report_id, layout_id, font_size, standard, standard_english, standard_description, standard_description_english, target_audience, target_audience_english, methodology, methodology_english, prerequisite, prerequisite_english, além de code, course e group do curso.
POST /comercial/courses/{course_uuid}/complements
Cria o registro de complementos. Se o curso já tem registro, o sistema restaura o registro (caso tenha sido apagado) e atualiza os campos enviados, em vez de criar outro.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
report_id | Não | Número (id) | Modelo de certificado do cliente |
layout_id | Não | Número (id) | Layout do certificado. Veja GET /comercial/courses/layouts em Cursos |
font_size | Não | Número | Tamanho da fonte usado no certificado |
standard | Não | Texto | Texto legal da norma, por exemplo "nos termos da ...". Use este campo para a norma, e não o nome do curso |
standard_english | Não | Texto | Norma em inglês |
standard_description | Não | Texto | Descrição complementar da norma |
standard_description_english | Não | Texto | Descrição complementar da norma em inglês |
target_audience | Não | Texto | Público-alvo do curso |
target_audience_english | Não | Texto | Público-alvo em inglês |
methodology | Não | Texto | Metodologia de ensino |
methodology_english | Não | Texto | Metodologia em inglês |
prerequisite | Não | Texto | Pré-requisitos para participar |
prerequisite_english | Não | Texto | Pré-requisitos em inglês |
Resposta: 200 com o registro de complementos.
PUT /comercial/courses/{course_uuid}/complements/{id}
Altera o registro de complementos. Envie apenas os campos que mudam, com os mesmos nomes da criação.
Resposta: 200 com o registro alterado.
Apagar
DELETE /comercial/courses/{course_uuid}/complements/{id}
Apaga o registro de complementos. A exclusão é lógica, e um novo POST restaura o registro.
Resposta: 200, sem corpo.