Complementos da empresa
Esta página descreve os endpoints da aba Complementos da empresa, da tela Cursos. Cada complemento é um texto do curso destinado a uma empresa cliente, e pode valer para todas as modalidades do curso ou só para uma delas. Esses textos são usados em modelos de certificado específicos de algumas empresas.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /comercial/courses/{course_uuid}/companies-complements | Lista os complementos da empresa do curso |
| POST | /comercial/courses/{course_uuid}/companies-complements | Cadastra um complemento |
| GET | /comercial/courses/{course_uuid}/companies-complements/{id} | Consulta um complemento |
| PUT | /comercial/courses/{course_uuid}/companies-complements/{id} | Altera um complemento |
| DELETE | /comercial/courses/{course_uuid}/companies-complements/{id} | Apaga um complemento (exclusão lógica) |
Consultar
GET /comercial/courses/{course_uuid}/companies-complements
Lista os complementos do curso.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
customer_vendor_id | Lista apenas os complementos da empresa informada (id da empresa) |
modality_id | Lista os complementos da modalidade informada e os que valem para todas as modalidades |
english | 1 lista os textos em inglês; 0 lista os demais |
search | Texto livre: nome do curso, código ou texto do complemento |
column e order | Ordenação. Sem ordenação, os textos em inglês vêm por último |
Resposta: lista. Campos principais: id, course_id, customer_vendor_id, customer_name, customer_company_name, modality_id, modality, complement, english, user_create_name e user_update_name.
GET /comercial/courses/{course_uuid}/companies-complements/{id}
Consulta um complemento pelo id. A resposta é o registro do complemento, com os dados do curso a que ele pertence.
Cadastrar e alterar
POST /comercial/courses/{course_uuid}/companies-complements
Cadastra um complemento para uma empresa.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
customer_vendor_id | Sim | Número (id) | Empresa cliente a que o complemento se aplica |
complement | Sim | Texto | Texto do complemento |
modality_id | Não | Número (id) | Modalidade do treinamento. Em branco, o complemento vale para todas as modalidades |
english | Não | Booleano | Indica que o texto está em inglês |
Resposta: 200 com o complemento criado.
PUT /comercial/courses/{course_uuid}/companies-complements/{id}
Altera um complemento. Todos os campos são opcionais; envie apenas os que mudam.
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
customer_vendor_id | Não | Número (id) | Empresa cliente |
complement | Não | Texto | Texto do complemento |
modality_id | Não | Número (id) | Modalidade do treinamento |
english | Não | Booleano | Texto em inglês |
Resposta: 200 com o complemento alterado.
Apagar
DELETE /comercial/courses/{course_uuid}/companies-complements/{id}
Apaga o complemento. A exclusão é lógica.
Resposta: 200, sem corpo.