Conteúdo programático
Esta página descreve os endpoints da aba Conteúdo programático, da tela Cursos. Cada item descreve um ponto do que o curso ensina. Os itens saem no certificado e no relatório de conteúdo programático em PDF.
Cada item é um registro próprio. Para cadastrar um conteúdo com vários itens, envie um POST por item, na ordem, com order sequencial. Assim cada resposta confirma o id criado antes do próximo passo.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /comercial/courses/{course_uuid}/syllabus | Lista os itens do conteúdo programático |
| POST | /comercial/courses/{course_uuid}/syllabus | Cadastra um item |
| PUT | /comercial/courses/{course_uuid}/syllabus/{id} | Altera um item |
| DELETE | /comercial/courses/{course_uuid}/syllabus/{id} | Apaga um item (exclusão lógica) |
| GET | /comercial/courses/{course_uuid}/syllabus/report | Gera o relatório em PDF do conteúdo programático |
| GET | /comercial/courses/syllabus/companies | Lista as empresas do cadastro do cliente, para o campo Empresa |
Consultar
GET /comercial/courses/{course_uuid}/syllabus
Lista os itens do conteúdo do curso, em ordem crescente de order.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
customer_vendor_id | Lista apenas os itens da empresa informada (id da empresa) |
search | Texto livre: conteúdo ou grupo do item |
inactive | 1 lista apenas os itens de cursos inativos |
columnName e orderData | Ordenação: nome da coluna e asc ou desc |
Resposta: lista. Campos principais: id, course_id, customer_vendor_id, customer_name, customer_company_name, customer_document, order, content, content_english, group, group_english, workload, updated_at, user_create_name e user_update_name.
GET /comercial/courses/{course_uuid}/syllabus/report
Gera o relatório em PDF do conteúdo programático. O PDF lista os itens com a numeração, o conteúdo (e o texto em inglês, quando houver), a carga horária do item, quando preenchida, e o total de horas.
Resposta: arquivo PDF para download.
Cadastrar e alterar
POST /comercial/courses/{course_uuid}/syllabus
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
content | Sim | Texto | Texto do item. Inclua a letra ou o número do item quando o certificado usa essa numeração |
order | Não | Inteiro | Posição do item. Em branco, o item entra no fim da sequência. Se a posição já existe, os itens a partir dela são empurrados uma posição para baixo |
customer_vendor_id | Não | Número (id) | Empresa, quando o item é específico dessa empresa |
content_english | Não | Texto | Texto do item em inglês |
group | Não | Texto | Nome do bloco ao qual o item pertence, por exemplo "Módulo Teórico" ou "Módulo Prático" |
group_english | Não | Texto | Nome do bloco em inglês |
workload | Não | Inteiro | Carga horária do item, em horas |
broken | Não | Booleano | Quando true e o content tem quebras de linha, cria um item para cada linha. Nesse caso, a resposta traz apenas o último item criado |
Em conteúdos com módulos, use group com o nome do bloco, copiado como está no certificado. O order continua sequencial em todo o curso, e não recomeça em cada bloco.
Exemplo
{"order": 1, "content": "a) Conceitos básicos;"}
Resposta: 201 com o item criado.
PUT /comercial/courses/{course_uuid}/syllabus/{id}
Altera um item. Todos os campos são opcionais; envie apenas os que mudam. Alterar o order não reordena os demais itens.
Resposta: 200 com o item alterado.
Apagar
DELETE /comercial/courses/{course_uuid}/syllabus/{id}
Apaga o item. A exclusão é lógica.
Resposta: 200, sem corpo.
Listas de apoio
GET /comercial/courses/syllabus/companies
Lista as empresas do cadastro do cliente. É a lista de referência para os itens específicos de uma empresa.