Matricule alunos em uma turma

Indique uma turma e envie um ou mais objetos de alunos para registrá-los na turma.

POST /api/classes/{turma_id}/attach

Matricule alunos em uma turma

cURL

curl --request POST \
  --url https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    {}
  ],
  "birth_date": "<string>",
  "cpf": "<string>",
  "registration_start_date": "<string>",
  "registration_end_date": "<string>",
  "enrollment_renewal": true,
  "id": 123
}
'

200

{
  "data": [
    {
      "user_id": 123,
      "user_name": "<string>",
      "school_id": 123,
      "class_id": "<string>",
      "class_name": "<string>",
      "birth_date": "<string>",
      "cpf": "<string>",
      "registration_start_date": "<string>",
      "registration_end_date": "<string>",
      "enrollment_renewal": true,
      "id": {}
    }
  ]
}

Parâmetros

turma_id · string · required

Número identificador da turma na qual o aluno, ou os alunos, serão matriculados.

users · array · required

Lista de usuários a serem matriculados e registrados. Caso o usuário já exista, é possível vinculá-lo via ID, utilizando a chave “id” com o respectivo valor.

birth_date · string

Data de nascimento do usuário no formato YYYY-MM-DD.

cpf · string

Número do CPF do usuário, contendo exatamente 11 dígitos numéricos.

registration_start_date · string

Data de início da matrícula do usuário, no formato YYYY-MM-DD.

registration_end_date · string

Data de término da matrícula do usuário, no formato YYYY-MM-DD. Deve ser igual ou posterior à data atual.

enrollment_renewal · boolean

Flag que indica se a matrícula será renovada.

id · int

Identificador ou código da turma para validação. Pode ser numérico ou alfanumérico.

Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:

• IDTurma: Código da turma na qual você deseja matricular o(s) aluno(s). Deve ser passado na URL.

• users: Uma lista (array) de objetos contendo informações dos alunos a serem matriculados na turma ou apenas uma lista com os e-mails dos alunos já cadastrados na plataforma.

• name: obrigatório para alunos não registrados: Nome do aluno a ser matriculado.

• email: obrigatório para alunos não registrados: Endereço de e-mail do aluno a ser matriculado.

• id: opcional, pode ser utilizado para usuários já registrados: ID do aluno registrado na instituição.

Descrição da Resposta

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

data · array

Lista de associações entre usuários e a turma.

Show items

user_id · number

Identificador único do usuário.

user_name · string

Nome do usuário.

school_id · number

Identificador único da escola associada.

class_id · string

Identificador único da turma.

class_name · string

Nome da turma.

birth_date · string

Data de nascimento do usuário no formato YYYY-MM-DD.

cpf · string

CPF do usuário, contendo exatamente 11 dígitos.

registration_start_date · string

Data de início da matrícula do usuário na turma.

registration_end_date · string

Data de término da matrícula do usuário na turma.

enrollment_renewal · boolean

Indica se a matrícula do usuário foi renovada (true) ou não (false).

id · string|integer

Identificador ou código da turma usado para validação. Pode ser numérico ou alfanumérico.

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.