Instrutores da turma
As pessoas responsáveis pela turma, cada uma com o papel que ocupa na turma (instrutor, responsável técnico ou outro tipo cadastrado pelo cliente). Na tela, ficam na aba Turmas > Instrutores da página da turma. A especialização do instrutor é opcional e aparece depois que o instrutor é escolhido.
Nas rotas desta página, {class_uuid} é o uuid da turma e {id} é o identificador numérico do instrutor na turma.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
GET | /comercial/classes/{class_uuid}/instructors | Lista os instrutores da turma |
POST | /comercial/classes/{class_uuid}/instructors | Inclui um instrutor na turma |
GET | /comercial/classes/{class_uuid}/instructors/{id} | Consulta um instrutor da turma |
PUT | /comercial/classes/{class_uuid}/instructors/{id} | Altera um instrutor da turma |
DELETE | /comercial/classes/{class_uuid}/instructors/{id} | Remove um instrutor da turma |
GET | /comercial/classes/{class_uuid}/instructors/{employee_id}/specializations | Lista as especializações de um instrutor (lista de apoio) |
Listar e incluir
GET /comercial/classes/{class_uuid}/instructors
Lista os instrutores da turma informada na URL.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
search | Texto livre para buscar pelo nome do instrutor, pelo tipo de responsável ou pela especialização |
column e order | Ordena pela coluna informada, em asc ou desc |
per_page e page | Paginação. Sem per_page, a resposta é a lista completa |
Resposta: 200. Cada item traz o registro do instrutor na turma, o tipo de responsável, o nome, o e-mail e o celular do instrutor, o cargo, a especialização e os nomes de quem criou e alterou o registro.
POST /comercial/classes/{class_uuid}/instructors
Inclui um instrutor na turma.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
responsable_type_id | Sim | Texto | uuid do tipo de responsável (papel do instrutor na turma), cadastrado pelo cliente |
instructor_id | Sim | Número | Id do instrutor, cadastrado como funcionário do cliente |
specialization_id | Não | Número | Id da especialização do instrutor |
curl -X POST "https://api.pedagogo.app/comercial/classes/<uuid-da-turma>/instructors" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"responsable_type_id": "<uuid-do-tipo-de-responsavel>", "instructor_id": 77}'
Resposta: 200 com o instrutor incluído na turma.
Consultar, alterar e apagar
GET /comercial/classes/{class_uuid}/instructors/{id}
Consulta um instrutor da turma.
Resposta: 200 com o instrutor.
PUT /comercial/classes/{class_uuid}/instructors/{id}
Altera um instrutor da turma. Na tela, a edição fica oculta quando a turma está Cancelada.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
responsable_type_id | Não | Texto | uuid do tipo de responsável |
instructor_id | Não | Número | Id do instrutor |
specialization_id | Não | Número | Id da especialização do instrutor |
Resposta: 200 com o instrutor alterado.
DELETE /comercial/classes/{class_uuid}/instructors/{id}
Remove um instrutor da turma. A remoção é lógica. Na tela, a ação fica oculta quando a turma está Cancelada.
Resposta: 200, com corpo null.
Listas auxiliares
- Especializações do instrutor (
GET .../instructors/{employee_id}/specializations): lista as especializações cadastradas para o instrutor informado em{employee_id}, que é o id do instrutor no cadastro de funcionários. Cada item traz a especialização, o número do documento, a data de conclusão e a data de validade. Aceitasearch,column,order,per_pageepage. Esta lista alimenta o campo Especialização da aba.