Instrutores
Esta página descreve os endpoints da aba Instrutores, da tela Cursos. Ela define quem ministra ou responde pelo curso e em qual papel (por exemplo, instrutor ou responsável técnico). Os instrutores aparecem nas turmas e nas listas de presença.
Ao cadastrar um instrutor no curso, ele também passa a constar como instrutor qualificado do curso (veja Instrutores qualificados). Não é preciso cadastrá-lo lá separadamente.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /comercial/courses/{course_uuid}/instructors | Lista os instrutores do curso |
| POST | /comercial/courses/{course_uuid}/instructors | Inclui um instrutor no curso |
| GET | /comercial/courses/{course_uuid}/instructors/{id} | Consulta um instrutor do curso |
| PUT | /comercial/courses/{course_uuid}/instructors/{id} | Altera um instrutor do curso |
| DELETE | /comercial/courses/{course_uuid}/instructors/{id} | Remove um instrutor do curso (exclusão lógica) |
| GET | /comercial/courses/instructors | Lista as pessoas cadastradas como instrutor |
| GET | /comercial/courses/instructors/responsables-types | Lista os tipos de responsável |
| GET | /comercial/courses/instructors/{employee_id}/specializations | Lista as especializações de um instrutor |
Consultar
GET /comercial/courses/{course_uuid}/instructors
Lista os instrutores do curso.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
responsable_type_id | Lista os instrutores com o tipo de responsável informado. Aceita um id ou uma lista de ids |
not_responsable_type_id | Exclui o tipo de responsável informado |
instructor_id | Lista apenas o instrutor informado (id do instrutor) |
search | Texto livre: nome do curso, nome do instrutor, tipo de responsável ou especialização |
attendance_list | 1 lista apenas os tipos de responsável que aparecem na lista de presença |
contacts_only | 1 lista apenas os instrutores com e-mail ou celular cadastrado |
columnName e orderData | Ordenação: nome da coluna e asc ou desc |
Resposta: lista. Campos principais: id, course_id, instructor_id, instructor_name, instructor_email, instructor_cellphone, responsable_type_id, responsable_type, specialization_id, specialization, daily_rate, user_create_name e user_update_name.
GET /comercial/courses/{course_uuid}/instructors/{id}
Consulta um instrutor do curso pelo id. A resposta traz o registro com os dados do curso.
Cadastrar e alterar
POST /comercial/courses/{course_uuid}/instructors
Inclui um instrutor no curso. Para incluir o mesmo instrutor com dois papéis (por exemplo, instrutor e responsável técnico), faça um POST para cada papel.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
responsable_type_id | Sim | Número (id) | Papel da pessoa no curso. Veja GET /comercial/courses/instructors/responsables-types nesta página |
instructor_id | Sim | Número (id) | Pessoa cadastrada como instrutor. Veja GET /comercial/courses/instructors nesta página |
specialization_id | Não | Número (id) | Especialização do instrutor. Veja GET /comercial/courses/instructors/{employee_id}/specializations |
daily_rate | Não | Número | Valor da diária do instrutor |
Para preencher a especialização, consulte a lista de especializações do instrutor antes do cadastro. Se houver uma só, use o id dela.
Resposta: 200 com o instrutor incluído no curso.
PUT /comercial/courses/{course_uuid}/instructors/{id}
Altera o instrutor do curso. responsable_type_id e instructor_id são obrigatórios também nesta alteração, mesmo que não mudem. Os demais campos são os mesmos do cadastro.
Resposta: 200 com o registro alterado.
Apagar
DELETE /comercial/courses/{course_uuid}/instructors/{id}
Remove o instrutor do curso. A exclusão é lógica.
Resposta: 200, sem corpo.
Listas de apoio
GET /comercial/courses/instructors
Lista as pessoas cadastradas como instrutor. Parâmetros: search (nome, razão social ou documento). Use o id do instrutor no campo instructor_id.
GET /comercial/courses/instructors/responsables-types
Lista os tipos de responsável cadastrados para a empresa cliente. Use o id no campo responsable_type_id.
GET /comercial/courses/instructors/{employee_id}/specializations
Lista as especializações do instrutor. O parâmetro employee_id é o id do instrutor, retornado pela lista de instrutores. Use o id da especialização no campo specialization_id.