Treinamentos

Corresponde à aba Treinamentos, na tela Configurações do módulo Administrativo. Cadastra as listas usadas pelo catálogo de cursos e pelas turmas: grupos de cursos, modalidades e tipos de responsável.

Os endpoints seguem o padrão das demais listas de Configurações: search busca pelo nome do item, e per_page e page paginam a resposta, como descrito em Convenções.

Grupos

Agrupa os cursos do catálogo, por exemplo NR, Saúde ou Idiomas. O grupo é escolhido no cadastro de cada curso, no módulo Comercial. Um grupo marcado como não sendo curso não entra na emissão de certificados.

Endpoints

Método	Caminho	Descrição
GET	/administrative/settings/comercial/groups	Lista os grupos de cursos
POST	/administrative/settings/comercial/groups	Cadastra um grupo de cursos
GET	/administrative/settings/comercial/groups/{uuid}	Consulta um grupo de cursos
PUT	/administrative/settings/comercial/groups/{uuid}	Altera um grupo de cursos
DELETE	/administrative/settings/comercial/groups/{uuid}	Apaga um grupo de cursos

GET /administrative/settings/comercial/groups

Parâmetros de URL: search (busca pelo nome do grupo), column, order, per_page e page. Para ordenar, use column (nome da coluna) e order (asc ou desc).

Resposta (200): lista de grupos, direta ou paginada. Campos: uuid, client_id, group e not_course.

Exemplo:

curl https://api.pedagogo.app/administrative/settings/comercial/groups \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

POST /administrative/settings/comercial/groups

Corpo (JSON)

Campo	Obrigatório	Tipo	Descrição
group	Sim	Texto	Nome do grupo
not_course	Não	Booleano	Marca o grupo como não sendo curso

Resposta (200): o grupo criado, com o uuid.

Exemplo:

curl -X POST https://api.pedagogo.app/administrative/settings/comercial/groups \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Content-Type: application/json" \
  -d '{"group": "Grupo exemplo", "not_course": false}'

Consultar, alterar e apagar

• GET /administrative/settings/comercial/groups/{uuid}: devolve o grupo pelo uuid.
• PUT /administrative/settings/comercial/groups/{uuid}: corpo com group (Sim, texto) e not_course (Não, booleano). Resposta (200): o grupo alterado.
• DELETE /administrative/settings/comercial/groups/{uuid}: exclusão lógica. Resposta (200), sem conteúdo relevante (null).

Modalidades

Cadastra as modalidades de ensino, por exemplo presencial, EAD ou in company. A modalidade é obrigatória ao criar uma turma. Criar uma modalidade com o nome de uma que foi apagada restaura a anterior.

Endpoints

Método	Caminho	Descrição
GET	/administrative/settings/comercial/modalities	Lista as modalidades
POST	/administrative/settings/comercial/modalities	Cadastra uma modalidade
GET	/administrative/settings/comercial/modalities/{uuid}	Consulta uma modalidade
PUT	/administrative/settings/comercial/modalities/{uuid}	Altera uma modalidade
DELETE	/administrative/settings/comercial/modalities/{uuid}	Apaga uma modalidade

GET /administrative/settings/comercial/modalities

Parâmetros de URL: search (busca pelo nome da modalidade), columnName, orderData, per_page e page.

Resposta (200): lista de modalidades. Campos: id, uuid, client_id e modality.

POST /administrative/settings/comercial/modalities

Corpo (JSON)

Campo	Obrigatório	Tipo	Descrição
modality	Sim	Texto	Nome da modalidade

Resposta (201): a modalidade criada. Se já existia uma modalidade com o mesmo nome no cliente, ela é restaurada e atualizada, e não é duplicada.

Consultar, alterar e apagar

• GET /administrative/settings/comercial/modalities/{uuid}: devolve a modalidade pelo uuid.
• PUT /administrative/settings/comercial/modalities/{uuid}: corpo com modality (Sim, texto). Resposta (200): a modalidade alterada.
• DELETE /administrative/settings/comercial/modalities/{uuid}: exclusão lógica. Resposta (200), sem conteúdo relevante (null).

Tipos responsáveis

Cadastra os papéis que um instrutor ou responsável pode ter numa turma ou curso, por exemplo Instrutor, Coordenador ou Monitor. Ao vincular um instrutor a uma turma ou curso, é obrigatório escolher o tipo responsável.

Endpoints

Método	Caminho	Descrição
GET	/administrative/settings/responsables-types	Lista os tipos responsáveis
POST	/administrative/settings/responsables-types	Cadastra um tipo responsável
PUT	/administrative/settings/responsables-types/{uuid}	Altera um tipo responsável
DELETE	/administrative/settings/responsables-types/{uuid}	Apaga um tipo responsável

GET /administrative/settings/responsables-types

Parâmetros de URL: search (busca pelo nome do tipo), responsable_type_id (traz só o tipo com esse id), column, order, per_page e page. Para ordenar, use column e order.

Resposta (200): lista de tipos, direta ou paginada.

POST /administrative/settings/responsables-types

Corpo (JSON)

Campo	Obrigatório	Tipo	Descrição
responsable_type	Sim	Texto (até 255 caracteres)	Nome do papel, por exemplo Instrutor
attendance_list	Não	Booleano	Quando marcado, o responsável aparece nas listas de presença impressas

Resposta (200): o tipo criado, com o uuid.

PUT /administrative/settings/responsables-types/{uuid}

Altera um tipo responsável. Envie apenas os campos que devem mudar.

Corpo (JSON)

Campo	Obrigatório	Tipo	Descrição
responsable_type	Não	Texto (até 255 caracteres)	Novo nome do papel
attendance_list	Não	Booleano	Marca ou desmarca a presença nas listas impressas

Resposta (200): o tipo alterado.

DELETE /administrative/settings/responsables-types/{uuid}

Apaga o tipo responsável. A exclusão é lógica.

Resposta (200): sem conteúdo relevante (null).