Matricule alunos em uma turma
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
}
'import requests
url = "https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach"
payload = {
"users": [{}],
"birth_date": "<string>",
"cpf": "<string>",
"registration_start_date": "<string>",
"registration_end_date": "<string>",
"enrollment_renewal": True,
"id": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
users: [{}],
birth_date: '<string>',
cpf: '<string>',
registration_start_date: '<string>',
registration_end_date: '<string>',
enrollment_renewal: true,
id: 123
})
};
fetch('https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'users' => [
[
]
],
'birth_date' => '<string>',
'cpf' => '<string>',
'registration_start_date' => '<string>',
'registration_end_date' => '<string>',
'enrollment_renewal' => true,
'id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach"
payload := strings.NewReader("{\n \"users\": [\n {}\n ],\n \"birth_date\": \"<string>\",\n \"cpf\": \"<string>\",\n \"registration_start_date\": \"<string>\",\n \"registration_end_date\": \"<string>\",\n \"enrollment_renewal\": true,\n \"id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach")
.header("Content-Type", "application/json")
.body("{\n \"users\": [\n {}\n ],\n \"birth_date\": \"<string>\",\n \"cpf\": \"<string>\",\n \"registration_start_date\": \"<string>\",\n \"registration_end_date\": \"<string>\",\n \"enrollment_renewal\": true,\n \"id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"users\": [\n {}\n ],\n \"birth_date\": \"<string>\",\n \"cpf\": \"<string>\",\n \"registration_start_date\": \"<string>\",\n \"registration_end_date\": \"<string>\",\n \"enrollment_renewal\": true,\n \"id\": 123\n}"
response = http.request(request)
puts response.read_body{
"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": {}
}
]
}Turmas
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 --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
}
'import requests
url = "https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach"
payload = {
"users": [{}],
"birth_date": "<string>",
"cpf": "<string>",
"registration_start_date": "<string>",
"registration_end_date": "<string>",
"enrollment_renewal": True,
"id": 123
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
users: [{}],
birth_date: '<string>',
cpf: '<string>',
registration_start_date: '<string>',
registration_end_date: '<string>',
enrollment_renewal: true,
id: 123
})
};
fetch('https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'users' => [
[
]
],
'birth_date' => '<string>',
'cpf' => '<string>',
'registration_start_date' => '<string>',
'registration_end_date' => '<string>',
'enrollment_renewal' => true,
'id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach"
payload := strings.NewReader("{\n \"users\": [\n {}\n ],\n \"birth_date\": \"<string>\",\n \"cpf\": \"<string>\",\n \"registration_start_date\": \"<string>\",\n \"registration_end_date\": \"<string>\",\n \"enrollment_renewal\": true,\n \"id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach")
.header("Content-Type", "application/json")
.body("{\n \"users\": [\n {}\n ],\n \"birth_date\": \"<string>\",\n \"cpf\": \"<string>\",\n \"registration_start_date\": \"<string>\",\n \"registration_end_date\": \"<string>\",\n \"enrollment_renewal\": true,\n \"id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://kong.api.toolzz.com.br/api/classes/{turma_id}/attach")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"users\": [\n {}\n ],\n \"birth_date\": \"<string>\",\n \"cpf\": \"<string>\",\n \"registration_start_date\": \"<string>\",\n \"registration_end_date\": \"<string>\",\n \"enrollment_renewal\": true,\n \"id\": 123\n}"
response = http.request(request)
puts response.read_body{
"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
string
required
Número identificador da turma na qual o aluno, ou os alunos, serão matriculados.
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.
string
Data de nascimento do usuário no formato YYYY-MM-DD.
string
Número do CPF do usuário, contendo exatamente 11 dígitos numéricos.
string
Data de início da matrícula do usuário, no formato YYYY-MM-DD.
string
Data de término da matrícula do usuário, no formato YYYY-MM-DD. Deve ser igual ou posterior à data atual.
boolean
Flag que indica se a matrícula será renovada.
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.array
Lista de associações entre usuários e a turma.
Show items
Show items
number
Identificador único do usuário.
string
Nome do usuário.
number
Identificador único da escola associada.
string
Identificador único da turma.
string
Nome da turma.
string
Data de nascimento do usuário no formato
YYYY-MM-DD.string
CPF do usuário, contendo exatamente 11 dígitos.
string
Data de início da matrícula do usuário na turma.
string
Data de término da matrícula do usuário na turma.
boolean
Indica se a matrícula do usuário foi renovada (
true) ou não (false).string|integer
Identificador ou código da turma usado para validação. Pode ser numérico ou alfanumérico.