Criar Turmas
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>"
}
'import requests
url = "https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms"
payload = {
"schoolId": "<string>",
"type": "<string>",
"code": "<string>",
"title": "<string>",
"group": [{}],
"subgroups": [{}],
"specialties": [{}],
"contents": [{}],
"registration_start_date": "<string>",
"registration_end_date": "<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({
schoolId: '<string>',
type: '<string>',
code: '<string>',
title: '<string>',
group: [{}],
subgroups: [{}],
specialties: [{}],
contents: [{}],
registration_start_date: '<string>',
registration_end_date: '<string>'
})
};
fetch('https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms', 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://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms",
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([
'schoolId' => '<string>',
'type' => '<string>',
'code' => '<string>',
'title' => '<string>',
'group' => [
[
]
],
'subgroups' => [
[
]
],
'specialties' => [
[
]
],
'contents' => [
[
]
],
'registration_start_date' => '<string>',
'registration_end_date' => '<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://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms"
payload := strings.NewReader("{\n \"schoolId\": \"<string>\",\n \"type\": \"<string>\",\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"group\": [\n {}\n ],\n \"subgroups\": [\n {}\n ],\n \"specialties\": [\n {}\n ],\n \"contents\": [\n {}\n ],\n \"registration_start_date\": \"<string>\",\n \"registration_end_date\": \"<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://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms")
.header("Content-Type", "application/json")
.body("{\n \"schoolId\": \"<string>\",\n \"type\": \"<string>\",\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"group\": [\n {}\n ],\n \"subgroups\": [\n {}\n ],\n \"specialties\": [\n {}\n ],\n \"contents\": [\n {}\n ],\n \"registration_start_date\": \"<string>\",\n \"registration_end_date\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms")
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 \"schoolId\": \"<string>\",\n \"type\": \"<string>\",\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"group\": [\n {}\n ],\n \"subgroups\": [\n {}\n ],\n \"specialties\": [\n {}\n ],\n \"contents\": [\n {}\n ],\n \"registration_start_date\": \"<string>\",\n \"registration_end_date\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}Turmas
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 --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>"
}
'import requests
url = "https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms"
payload = {
"schoolId": "<string>",
"type": "<string>",
"code": "<string>",
"title": "<string>",
"group": [{}],
"subgroups": [{}],
"specialties": [{}],
"contents": [{}],
"registration_start_date": "<string>",
"registration_end_date": "<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({
schoolId: '<string>',
type: '<string>',
code: '<string>',
title: '<string>',
group: [{}],
subgroups: [{}],
specialties: [{}],
contents: [{}],
registration_start_date: '<string>',
registration_end_date: '<string>'
})
};
fetch('https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms', 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://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms",
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([
'schoolId' => '<string>',
'type' => '<string>',
'code' => '<string>',
'title' => '<string>',
'group' => [
[
]
],
'subgroups' => [
[
]
],
'specialties' => [
[
]
],
'contents' => [
[
]
],
'registration_start_date' => '<string>',
'registration_end_date' => '<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://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms"
payload := strings.NewReader("{\n \"schoolId\": \"<string>\",\n \"type\": \"<string>\",\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"group\": [\n {}\n ],\n \"subgroups\": [\n {}\n ],\n \"specialties\": [\n {}\n ],\n \"contents\": [\n {}\n ],\n \"registration_start_date\": \"<string>\",\n \"registration_end_date\": \"<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://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms")
.header("Content-Type", "application/json")
.body("{\n \"schoolId\": \"<string>\",\n \"type\": \"<string>\",\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"group\": [\n {}\n ],\n \"subgroups\": [\n {}\n ],\n \"specialties\": [\n {}\n ],\n \"contents\": [\n {}\n ],\n \"registration_start_date\": \"<string>\",\n \"registration_end_date\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms")
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 \"schoolId\": \"<string>\",\n \"type\": \"<string>\",\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"group\": [\n {}\n ],\n \"subgroups\": [\n {}\n ],\n \"specialties\": [\n {}\n ],\n \"contents\": [\n {}\n ],\n \"registration_start_date\": \"<string>\",\n \"registration_end_date\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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
string
required
O identificador da escola à qual a turma será associada.
string
required
O tipo de turma a ser estabelecida, que pode ser baseada na filtragem de grupos, subgrupos e especialidades.
string
required
Código da turma: identificador único com 1 a 10 caracteres.
string
required
Título da turma: descrição em formato string com até 255 caracteres.
array
Grupos: conjunto de identificadores dos grupos relacionados à turma. Obrigatório se o parâmetro
type for FILTER.array
Subgrupos: conjunto de identificadores dos subgrupos associados à turma. Obrigatório se o parâmetro
type for FILTER.array
Especialidades: conjunto de identificadores das especialidades vinculadas à turma. Obrigatório se o parâmetro
type for FILTER.array
Conteúdos exclusivos. Obrigatório quando o parâmetro
type for EXCLUSIVE_CONTENT.string
Data de início das inscrições.
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.boolean
Indica se a requisição foi bem-sucedida.
object
Detalhes da turma criada.
Show properties
Show properties
number
Identificador único da turma.
string
Identificador da escola associada.
string
Título da turma.
string
Código da turma.
string
URL da imagem da turma (pode ser nula).
string
Nome do curso associado (pode ser nulo).
array
array
array
array
Lista de trilhas associadas à turma.
array
Lista de conteúdos associados à turma.
string
Data e hora de criação da turma.
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.