Acreditações
Esta página descreve os endpoints da aba Acreditações, da tela Cursos. Uma acreditação registra que o curso é acreditado ou reconhecido por uma entidade, com o código de registro, a portaria e a validade. Um curso pode ter várias acreditações.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /comercial/courses/{course_uuid}/accreditations | Lista as acreditações do curso |
| POST | /comercial/courses/{course_uuid}/accreditations | Cadastra uma acreditação |
| PUT | /comercial/courses/{course_uuid}/accreditations/{id} | Altera uma acreditação |
| DELETE | /comercial/courses/{course_uuid}/accreditations/{id} | Apaga uma acreditação (exclusão lógica) |
| GET | /comercial/courses/accreditations/companies | Lista as empresas do cadastro do cliente, para o campo Empresa |
Consultar
GET /comercial/courses/{course_uuid}/accreditations
Lista as acreditações do curso.
Parâmetros de URL: column e order para ordenação.
Resposta: lista. Campos principais: id, course_id, company_id, company_name, company_company_name, belong_to, registred_code, accreditation_date, ordinance, ordinance_english, due_date, observations, updated_at, user_create_name e user_update_name.
Cadastrar e alterar
POST /comercial/courses/{course_uuid}/accreditations
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
belong_to | Sim | Texto | Entidade que acredita o curso |
registred_code | Sim | Texto | Número de registro da acreditação |
company_id | Não | Número (id) | Empresa do cadastro do cliente, quando a acreditação é de uma empresa cadastrada. Veja a lista de empresas deste endpoint |
accreditation_date | Não | Data | Data da portaria |
ordinance | Não | Texto | Portaria, número ou descrição |
ordinance_english | Não | Texto | Portaria em inglês |
due_date | Não | Data | Data até a qual a acreditação vale |
observations | Não | Texto | Informações complementares |
Resposta: 200 com a acreditação criada.
PUT /comercial/courses/{course_uuid}/accreditations/{id}
Altera uma acreditação. Envie apenas os campos que mudam, com os mesmos nomes da criação. Só company_id é validado nesta alteração.
Resposta: 200 com a acreditação alterada.
Apagar
DELETE /comercial/courses/{course_uuid}/accreditations/{id}
Apaga a acreditação. A exclusão é lógica.
Resposta: 200, sem corpo.
Listas de apoio
GET /comercial/courses/accreditations/companies
Lista as empresas do cadastro do cliente, para preencher o campo company_id. Use o id retornado.