Gerenciar turmas

Criar uma turma

curl -X POST "https://api.clinicanasnuvens.com.br/turma/nova" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  -H "Content-Type: application/json" \
  -d '{
    "codigoTurma": "ODO-2026-1",
    "nome": "Clínica Integrada I",
    "coordenadorEmail": "ana.souza@escola.edu.br",
    "ativo": true,
    "periodoLetivo": "2026/1",
    "nivelEnsino": "GRADUACAO",
    "disciplina": { "codigoDisciplina": "ODO401", "nome": "Clínica Integrada" }
  }'

Campos da requisição

Campo	Tipo	Obrigatório	Descrição
`codigoTurma`	String	Sim	Código da turma, único na clínica, com até 50 caracteres. Não pode ser alterado depois
`nome`	String	Sim	Nome da turma, com até 255 caracteres
`coordenadorEmail`	String	Sim	E-mail de login do coordenador, que precisa ser um orientador já cadastrado
`ativo`	Boolean	Não	Indica se a turma está em uso. Padrão `false`
`periodoLetivo`	String	Não	Período letivo, em texto livre, com até 50 caracteres
`nivelEnsino`	String	Não	Nível de ensino: `GRADUACAO` ou `POS_GRADUACAO`
`disciplina`	Object	Não	Disciplina da turma
`disciplina.codigoDisciplina`	String	Não	Código da disciplina, com até 50 caracteres
`disciplina.nome`	String	Não	Nome da disciplina, com até 255 caracteres

Resposta:

{
  "codigoTurma": "ODO-2026-1",
  "nome": "Clínica Integrada I",
  "coordenadorEmail": "ana.souza@escola.edu.br",
  "ativo": true,
  "periodoLetivo": "2026/1",
  "nivelEnsino": "GRADUACAO",
  "disciplina": { "codigoDisciplina": "ODO401", "nome": "Clínica Integrada" }
}

Três campos são obrigatórios: o código, o nome e o e-mail do coordenador.

Valor padrão de ativo

O campo ativo tem padrão false: quando omitido, a turma é criada inativa. Para criar a turma ativa, informe "ativo": true.

O coordenador deve ser um orientador já cadastrado. Profissionais alunos com supervisores vinculados não podem coordenar.

Criação automática da disciplina

Quando o codigoDisciplina informado não existe na clínica, uma disciplina é criada com o código e o nome enviados, e a turma é criada normalmente.

A turma é criada sem profissionais vinculados. O coordenador informado em coordenadorEmail fica registrado apenas como coordenador e não entra na lista de supervisores. Para que ele também atue como supervisor, vincule-o em Vincular profissionais.

Vincular profissionais

curl -X POST "https://api.clinicanasnuvens.com.br/turma/ODO-2026-1/profissionais" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  -H "Content-Type: application/json" \
  -d '{
    "profissionais": [
      { "email": "ana.souza@escola.edu.br", "tipo": "SUPERVISOR" },
      { "email": "joao.silva@escola.edu.br", "tipo": "ESTAGIARIO" },
      { "email": "maria.costa@escola.edu.br", "tipo": "ESTAGIARIO" }
    ]
  }'

Campos da requisição

Campo	Tipo	Obrigatório	Descrição
`profissionais`	Array	Sim	Profissionais a vincular à turma
`profissionais[].email`	String	Sim	E-mail de login do profissional, que já precisa estar cadastrado
`profissionais[].tipo`	String	Sim	Tipo de vínculo: `SUPERVISOR` ou `ESTAGIARIO`

Uma chamada pode vincular vários profissionais, supervisores e estagiários. A resposta não tem corpo.

Tipo e papel do profissional

Tipo enviado	Exigência
`SUPERVISOR`	O profissional deve ser orientador, sem supervisores vinculados
`ESTAGIARIO`	O profissional não pode ser orientador

O papel é definido no cadastro em Profissional de saúde escola.

Comportamento da operação

Aditiva. Os profissionais já vinculados permanecem; a lista enviada não substitui a existente.
Profissional já vinculado. O reenvio não gera erro nem altera o tipo. A troca de tipo é feita removendo e vinculando novamente.
E-mails repetidos. A verificação considera os profissionais já vinculados à turma; um e-mail repetido no mesmo array gera dois vínculos.
Transacional. Se um e-mail falhar, nenhum vínculo da chamada é gravado.

Consultar a turma

curl "https://api.clinicanasnuvens.com.br/turma/ODO-2026-1" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>"

Formato da resposta. A resposta é um array com um único elemento: [ { ... } ].

Na lista de profissionais, os supervisores vêm primeiro e os estagiários depois. O coordenador pode aparecer duas vezes: ele consta em coordenadorEmail e, se também estiver vinculado, aparece de novo em profissionais[].

Turmas inativas também são retornadas.

Alterar a turma

curl -X PUT "https://api.clinicanasnuvens.com.br/turma/ODO-2026-1" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  -H "Content-Type: application/json" \
  -d '{
    "nome": "Clínica Integrada I - Noturno",
    "coordenadorEmail": "ana.souza@escola.edu.br",
    "ativo": true,
    "periodoLetivo": "2026/1",
    "nivelEnsino": "GRADUACAO",
    "disciplina": { "codigoDisciplina": "ODO401", "nome": "Clínica Integrada" }
  }'

Resposta:

{
  "codigoTurma": "ODO-2026-1",
  "nome": "Clínica Integrada I - Noturno",
  "coordenadorEmail": "ana.souza@escola.edu.br",
  "ativo": true,
  "periodoLetivo": "2026/1",
  "nivelEnsino": "GRADUACAO",
  "disciplina": { "codigoDisciplina": "ODO401", "nome": "Clínica Integrada" }
}

A alteração substitui os dados da turma pelos enviados no corpo da requisição. Os campos não informados não são preservados; para manter os valores atuais, consulte a turma antes e envie o corpo da requisição completo.

Campo omitido	Efeito
`nome` `coordenadorEmail`	Campos Obrigatórios
`ativo`	Desativa a turma
`periodoLetivo`, `nivelEnsino`	Limpam o campo
`disciplina`	Desvincula a disciplina

O codigoTurma identifica a turma, não faz parte da requisição e não pode ser alterado.

Remover um profissional

curl -X DELETE "https://api.clinicanasnuvens.com.br/turma/ODO-2026-1/profissionais/joao.silva%40escola.edu.br" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>"

A operação remove o profissional das listas de supervisores e de estagiários, sem necessidade de informar o tipo. A resposta não tem corpo.

Agendamentos, planos de tratamento em andamento e atendimentos registrados do profissional na turma não impedem a remoção.

Outros comportamentos:

Profissional não vinculado. A remoção de um profissional que não está na turma retorna a mesma resposta de sucesso.
Coordenador. O coordenador é alterado pela alteração da turma, no campo coordenadorEmail.

O cadastro do profissional e os vínculos com outras turmas são mantidos.

Consultar as turmas de um profissional

curl "https://api.clinicanasnuvens.com.br/turma/profissional/joao.silva%40escola.edu.br" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>"

[
  { "codigoTurma": "ODO-2026-1", "coordenadorTurma": false, "tipoProfissional": "SUPERVISOR" },
  { "codigoTurma": "ODO-2026-3", "coordenadorTurma": true,  "tipoProfissional": null }
]

É a consulta inversa à consulta por turma. Sobre a resposta:

tipoProfissional é nulo quando o profissional apenas coordena a turma, sem estar vinculado como supervisor nem estagiário. Nesse caso, coordenadorTurma é true.
O profissional vinculado como supervisor e estagiário na mesma turma é retornado como SUPERVISOR.

Turmas inativas também são incluídas.

Veja na Referência

Os detalhes de cada operação, campo a campo, estão em Referência › Turma escola.

Criar uma turma​

Campos da requisição​

Vincular profissionais​

Campos da requisição​

Tipo e papel do profissional​

Comportamento da operação​

Consultar a turma​

Alterar a turma​

Remover um profissional​

Consultar as turmas de um profissional​

Veja na Referência​

Criar uma turma

Campos da requisição

Vincular profissionais

Campos da requisição

Tipo e papel do profissional

Comportamento da operação

Consultar a turma

Alterar a turma

Remover um profissional

Consultar as turmas de um profissional

Veja na Referência