Instrutores da turma

Instrutor da turma é um colaborador vinculado à turma com uma função (tipo de responsável) e, quando houver, uma especialização. Esta página cobre a listagem, o vínculo, a alteração e a remoção desses vínculos, e a consulta das especializações de um colaborador.

No manual de usuário, esta área é a aba Instrutores da turma, dentro do detalhe da turma (módulo Operacional).

As regras gerais estão em Convenções e a sessão em Autenticação. Os dados da turma estão em Turmas.

Endpoints

Método	Caminho	Descrição
GET	/operational/classes/{class_uuid}/instructors	Lista os instrutores e responsáveis vinculados à turma
POST	/operational/classes/{class_uuid}/instructors	Vincula um instrutor à turma
GET	/operational/classes/{class_uuid}/instructors/{id}	Consulta um vínculo de instrutor
PUT	/operational/classes/{class_uuid}/instructors/{id}	Altera um vínculo de instrutor
DELETE	/operational/classes/{class_uuid}/instructors/{id}	Remove o vínculo de um instrutor com a turma
GET	/operational/classes/{class_uuid}/instructors/{employee_id}/specializations	Lista as especializações de um colaborador

Listar instrutores da turma

GET /operational/classes/{class_uuid}/instructors

Lista os vínculos da turma informada. Cada item traz o colaborador (nome, e-mail e celular), o tipo de responsável, a especialização e os nomes dos usuários que criaram e alteraram o vínculo.

Parâmetros de URL

Parâmetro	Descrição
search	Busca no nome do instrutor, no tipo de responsável e na especialização
instructor_id	Colaborador (identificador do colaborador)
attendance_list	true para tipos de responsável que aparecem na lista de presença
contacts_only	true para vínculos com e-mail ou celular do colaborador
per_page	Quantidade por página. Se omitido, a lista vem completa
page	Número da página, com per_page
column	Coluna de ordenação, com order
order	Sentido da ordenação: asc ou desc, com column

Resposta

• 200: lista de vínculos ou, com per_page, objeto paginado (veja Convenções).

Campos principais: id, class_id, responsable_type_uuid, responsable_type, instructor_id, instructor_name, instructor_email, instructor_cellphone, role, specialization_id, specialization, code (código da turma), user_create_name, user_update_name, created_at e updated_at.

Exemplo

curl "https://api.pedagogo.app/operational/classes/<uuid-da-turma>/instructors?per_page=15" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

Vincular instrutor

POST /operational/classes/{class_uuid}/instructors

Vincula um colaborador à turma com uma função (tipo de responsável) e, opcionalmente, uma especialização.

Corpo

Campo	Obrigatório	Tipo	Descrição
responsable_type_id	Sim	uuid	Tipo de responsável (função do colaborador na turma)
instructor_id	Sim	inteiro	Colaborador (identificador do colaborador)
specialization_id	Não	inteiro	Especialização do colaborador (identificador da especialização)

Resposta

• 200: o vínculo criado.
• 404: turma não encontrada.
• 422: dados inválidos.

Exemplo

curl -X POST https://api.pedagogo.app/operational/classes/<uuid-da-turma>/instructors \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -d '{
    "responsable_type_id": "<uuid-do-tipo-de-responsavel>",
    "instructor_id": 12,
    "specialization_id": 3
  }'

Consultar, alterar e remover o vínculo

GET /operational/classes/{class_uuid}/instructors/{id}

Devolve o vínculo informado, com os dados da turma.

• 200: o vínculo.
• 404: vínculo não encontrado.

PUT /operational/classes/{class_uuid}/instructors/{id}

Altera o vínculo. Informe sempre o tipo de responsável ao alterar. Os campos e as regras são os mesmos do vínculo, mas todos são opcionais na alteração.

Corpo

Campo	Obrigatório	Tipo	Descrição
responsable_type_id	Não	uuid	Tipo de responsável
instructor_id	Não	inteiro	Colaborador
specialization_id	Não	inteiro	Especialização do colaborador

• 200: o vínculo alterado.
• 404: vínculo não encontrado.
• 422: dados inválidos.

DELETE /operational/classes/{class_uuid}/instructors/{id}

Remove o vínculo do colaborador com a turma (exclusão lógica).

• 200: sem conteúdo.
• 404: vínculo não encontrado.

Especializações do colaborador

GET /operational/classes/{class_uuid}/instructors/{employee_id}/specializations

Lista as especializações cadastradas para o colaborador informado. Use o identificador do colaborador (instructor_id) para consultar.

Parâmetros de URL: per_page e page.

Resposta: lista de especializações do colaborador, com id, a especialização, o nome do colaborador e os nomes dos usuários que criaram e alteraram o cadastro.

• 200: lista de especializações.