Criar Turmas

Com este endpoint, é possível vincular uma turma a uma escola, definir seu tipo, código e título, além de associá-la a grupos, subgrupos e especialidades.

POST /api/v1/schools/{schoolId}/classrooms

Criar Turmas

cURL

curl --request POST \
  --url https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms \
  --header 'Content-Type: application/json' \
  --data '
{
  "schoolId": "<string>",
  "type": "<string>",
  "code": "<string>",
  "title": "<string>",
  "group": [
    {}
  ],
  "subgroups": [
    {}
  ],
  "specialties": [
    {}
  ],
  "contents": [
    {}
  ],
  "registration_start_date": "<string>",
  "registration_end_date": "<string>"
}
'

200

{
  "success": true,
  "data": {
    "id": 123,
    "schoolId": "<string>",
    "title": "<string>",
    "code": "<string>",
    "image": "<string>",
    "course": "<string>",
    "group": [
      {
        "id": 123,
        "name": "<string>"
      }
    ],
    "subgroups": [
      {
        "id": 123,
        "name": "<string>"
      }
    ],
    "specialties": [
      {
        "id": 123,
        "name": "<string>"
      }
    ],
    "trails": [
      {}
    ],
    "contents": [
      {}
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Parâmetros

schoolId · string · required

O identificador da escola à qual a turma será associada.

type · string · required

O tipo de turma a ser estabelecida, que pode ser baseada na filtragem de grupos, subgrupos e especialidades.

code · string · required

Código da turma: identificador único com 1 a 10 caracteres.

title · string · required

Título da turma: descrição em formato string com até 255 caracteres.

group · array

Grupos: conjunto de identificadores dos grupos relacionados à turma. Obrigatório se o parâmetro type for FILTER.

subgroups · array

Subgrupos: conjunto de identificadores dos subgrupos associados à turma. Obrigatório se o parâmetro type for FILTER.

specialties · array

Especialidades: conjunto de identificadores das especialidades vinculadas à turma. Obrigatório se o parâmetro type for FILTER.

contents · array

Conteúdos exclusivos. Obrigatório quando o parâmetro type for EXCLUSIVE_CONTENT.

registration_start_date · string

Data de início das inscrições.

registration_end_date · string

Data de término das inscrições.

Este endpoint funcionará corretamente apenas se o domínio da sua instituição for informado manualmente na URL, caso contrário, o endpoint poderá falhar ou retornar um erro de validação.

Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.

success · boolean

Indica se a requisição foi bem-sucedida.

data · object

Detalhes da turma criada.

Show properties

id · number

Identificador único da turma.

schoolId · string

Identificador da escola associada.

title · string

Título da turma.

code · string

Código da turma.

image · string

URL da imagem da turma (pode ser nula).

course · string

Nome do curso associado (pode ser nulo).

group · array

Lista de grupos associados à turma.

Show items

id · number

Identificador único do grupo.

name · string

Nome do grupo.

subgroups · array

Lista de subgrupos associados à turma.

Show items

id · number

Identificador único do subgrupo.

name · string

Nome do subgrupo.

specialties · array

Lista de especialidades associadas à turma.

Show items

id · number

Identificador único da especialidade.

name · string

Nome da especialidade.

trails · array

Lista de trilhas associadas à turma.

contents · array

Lista de conteúdos associados à turma.

createdAt · string

Data e hora de criação da turma.

updatedAt · string

Data e hora da última atualização da turma.

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para garantir a proteção dos dados dos usuários.