Desmatricule alunos de uma turma
curl --request POST \
--url https://kong.api.toolzz.com.br/api/classes/{turma_id}/detach \
--header 'Content-Type: application/json' \
--data '
{
"users": [
{}
],
"id": "<string>",
"institution_code": "<string>"
}
'import requests
url = "https://kong.api.toolzz.com.br/api/classes/{turma_id}/detach"
payload = {
"users": [{}],
"id": "<string>",
"institution_code": "<string>"
}
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: [{}], id: '<string>', institution_code: '<string>'})
};
fetch('https://kong.api.toolzz.com.br/api/classes/{turma_id}/detach', 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}/detach",
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' => [
[
]
],
'id' => '<string>',
'institution_code' => '<string>'
]),
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}/detach"
payload := strings.NewReader("{\n \"users\": [\n {}\n ],\n \"id\": \"<string>\",\n \"institution_code\": \"<string>\"\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}/detach")
.header("Content-Type", "application/json")
.body("{\n \"users\": [\n {}\n ],\n \"id\": \"<string>\",\n \"institution_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://kong.api.toolzz.com.br/api/classes/{turma_id}/detach")
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 \"id\": \"<string>\",\n \"institution_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyTurmas
Desmatricule alunos de uma turma
Indique uma turma e envie um ou mais objetos de alunos para remover alunos da turma.
POST
/
api
/
classes
/
{turma_id}
/
detach
Desmatricule alunos de uma turma
curl --request POST \
--url https://kong.api.toolzz.com.br/api/classes/{turma_id}/detach \
--header 'Content-Type: application/json' \
--data '
{
"users": [
{}
],
"id": "<string>",
"institution_code": "<string>"
}
'import requests
url = "https://kong.api.toolzz.com.br/api/classes/{turma_id}/detach"
payload = {
"users": [{}],
"id": "<string>",
"institution_code": "<string>"
}
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: [{}], id: '<string>', institution_code: '<string>'})
};
fetch('https://kong.api.toolzz.com.br/api/classes/{turma_id}/detach', 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}/detach",
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' => [
[
]
],
'id' => '<string>',
'institution_code' => '<string>'
]),
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}/detach"
payload := strings.NewReader("{\n \"users\": [\n {}\n ],\n \"id\": \"<string>\",\n \"institution_code\": \"<string>\"\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}/detach")
.header("Content-Type", "application/json")
.body("{\n \"users\": [\n {}\n ],\n \"id\": \"<string>\",\n \"institution_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://kong.api.toolzz.com.br/api/classes/{turma_id}/detach")
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 \"id\": \"<string>\",\n \"institution_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyParâmetros
string
required
Número identificador da turma da qual o aluno ou alunos serão desmatriculados.
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
Identificador do aluno que será removido da turma.
string
Subdomínio da instituição desejada.
Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:
- IDTurma: Código da turma da qual você deseja desmatricular o aluno. Deve ser passado na URL.
- users: Uma lista de objetos contendo informações dos alunos a serem removidos da turma ou, alternativamente, apenas uma lista com os e-mails dos alunos já cadastrados na plataforma.
-
name:
obrigatório: Nome do aluno a ser removido. -
email:
obrigatório: Endereço de e-mail do aluno a ser removido.