Listar Turmas
curl --request GET \
--url https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classroomsimport requests
url = "https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
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 => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms")
.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::Get.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": 123,
"schoolId": 123,
"title": "<string>",
"code": "<string>",
"image": "<string>",
"course": "<string>",
"group": [
{
"id": 123,
"name": "<string>"
}
],
"subgroups": [
{
"id": 123,
"name": "<string>"
}
],
"specialties": [
{
"id": 123,
"name": "<string>"
}
],
"trails": [
{}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"meta": {
"total": 123,
"per_page": 123,
"current_page": 123,
"last_page": 123,
"first_page_url": "<string>",
"last_page_url": "<string>",
"next_page_url": "<string>",
"prev_page_url": "<string>",
"from": 123,
"to": 123
}
}Turmas
Listar Turmas
Este Endpoint permite listar informações essenciais sobre as turmas dentro das instituições educacionais.
GET
/
api
/
v1
/
schools
/
{schoolId}
/
classrooms
Listar Turmas
curl --request GET \
--url https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classroomsimport requests
url = "https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
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 => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://trialprod.app.toolzz.com.br/api/v1/schools/{schoolId}/classrooms")
.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::Get.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": 123,
"schoolId": 123,
"title": "<string>",
"code": "<string>",
"image": "<string>",
"course": "<string>",
"group": [
{
"id": 123,
"name": "<string>"
}
],
"subgroups": [
{
"id": 123,
"name": "<string>"
}
],
"specialties": [
{
"id": 123,
"name": "<string>"
}
],
"trails": [
{}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"meta": {
"total": 123,
"per_page": 123,
"current_page": 123,
"last_page": 123,
"first_page_url": "<string>",
"last_page_url": "<string>",
"next_page_url": "<string>",
"prev_page_url": "<string>",
"from": 123,
"to": 123
}
}Parâmetros
string
required
Identificador da escola à qual as turmas a serem listadas estão associadas.
string
Filtra as turmas a serem listadas pelo código.
string
Filtra as turmas a serem listadas pelo título.
string
Número da página dos registros de turmas a ser exibida.
number
Número de registros a serem exibidos por página. O valor máximo permitido é 100 registros.
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.
array
Lista de turmas.
Show items
Show items
number
Identificador único da turma.
number
Identificador da escola associada.
string
Título da turma.
string
Código da turma.
string
URL da imagem da turma.
string
Nome do curso associado.
array
array
array
array
Lista de trilhas associadas à turma.
string
Data e hora de criação da turma.
string
Data e hora da última atualização da turma.
object
Metadados sobre a resposta.
Show properties
Show properties
number
Número total de turmas.
number
Quantidade de itens por página.
number
Número da página atual.
number
Número da última página.
string
URL da primeira página.
string
URL da última página.
string
URL da próxima página (se disponível).
string
URL da página anterior (se disponível).
number
Índice do primeiro item na página atual.
number
Índice do último item na página atual.
Segurança
Para acessar este endpoint, é necessário enviar um token de acesso válido por meio 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.