Criar Unidades
curl --request POST \
--url https://endtest.app.toolzz.com.br/api/v1/schools \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"urlSlug": "<string>",
"groups": [
123
],
"subgroups": [
123
],
"specialties": [
123
],
"colorScheme": {
"primary": "<string>",
"secondary": "<string>",
"buttonText": "<string>"
},
"location": {
"street": "<string>",
"number": "<string>",
"district": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"features": {
"enableTeacherRegistration": true,
"enableStudentRegistration": true,
"enableGoogleLogin": true,
"enableLoginByDocument": true,
"enableLoginByEmail": true,
"isPartOfProgram": true,
"enableForum": true,
"enableViewCount": true,
"enableRating": true,
"enableReviews": true,
"showSchoolIconInMenu": true,
"showIconDetails": true,
"replicateInstitutionMenuLinks": true,
"displaySchoolAccessButton": true
},
"contractNumber": "<string>",
"tags": [
{}
],
"taxid": "<string>"
}
'import requests
url = "https://endtest.app.toolzz.com.br/api/v1/schools"
payload = {
"name": "<string>",
"urlSlug": "<string>",
"groups": [123],
"subgroups": [123],
"specialties": [123],
"colorScheme": {
"primary": "<string>",
"secondary": "<string>",
"buttonText": "<string>"
},
"location": {
"street": "<string>",
"number": "<string>",
"district": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"features": {
"enableTeacherRegistration": True,
"enableStudentRegistration": True,
"enableGoogleLogin": True,
"enableLoginByDocument": True,
"enableLoginByEmail": True,
"isPartOfProgram": True,
"enableForum": True,
"enableViewCount": True,
"enableRating": True,
"enableReviews": True,
"showSchoolIconInMenu": True,
"showIconDetails": True,
"replicateInstitutionMenuLinks": True,
"displaySchoolAccessButton": True
},
"contractNumber": "<string>",
"tags": [{}],
"taxid": "<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({
name: '<string>',
urlSlug: '<string>',
groups: [123],
subgroups: [123],
specialties: [123],
colorScheme: {primary: '<string>', secondary: '<string>', buttonText: '<string>'},
location: {
street: '<string>',
number: '<string>',
district: '<string>',
city: '<string>',
state: '<string>',
zipCode: '<string>'
},
features: {
enableTeacherRegistration: true,
enableStudentRegistration: true,
enableGoogleLogin: true,
enableLoginByDocument: true,
enableLoginByEmail: true,
isPartOfProgram: true,
enableForum: true,
enableViewCount: true,
enableRating: true,
enableReviews: true,
showSchoolIconInMenu: true,
showIconDetails: true,
replicateInstitutionMenuLinks: true,
displaySchoolAccessButton: true
},
contractNumber: '<string>',
tags: [{}],
taxid: '<string>'
})
};
fetch('https://endtest.app.toolzz.com.br/api/v1/schools', 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://endtest.app.toolzz.com.br/api/v1/schools",
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([
'name' => '<string>',
'urlSlug' => '<string>',
'groups' => [
123
],
'subgroups' => [
123
],
'specialties' => [
123
],
'colorScheme' => [
'primary' => '<string>',
'secondary' => '<string>',
'buttonText' => '<string>'
],
'location' => [
'street' => '<string>',
'number' => '<string>',
'district' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipCode' => '<string>'
],
'features' => [
'enableTeacherRegistration' => true,
'enableStudentRegistration' => true,
'enableGoogleLogin' => true,
'enableLoginByDocument' => true,
'enableLoginByEmail' => true,
'isPartOfProgram' => true,
'enableForum' => true,
'enableViewCount' => true,
'enableRating' => true,
'enableReviews' => true,
'showSchoolIconInMenu' => true,
'showIconDetails' => true,
'replicateInstitutionMenuLinks' => true,
'displaySchoolAccessButton' => true
],
'contractNumber' => '<string>',
'tags' => [
[
]
],
'taxid' => '<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://endtest.app.toolzz.com.br/api/v1/schools"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"urlSlug\": \"<string>\",\n \"groups\": [\n 123\n ],\n \"subgroups\": [\n 123\n ],\n \"specialties\": [\n 123\n ],\n \"colorScheme\": {\n \"primary\": \"<string>\",\n \"secondary\": \"<string>\",\n \"buttonText\": \"<string>\"\n },\n \"location\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"district\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"features\": {\n \"enableTeacherRegistration\": true,\n \"enableStudentRegistration\": true,\n \"enableGoogleLogin\": true,\n \"enableLoginByDocument\": true,\n \"enableLoginByEmail\": true,\n \"isPartOfProgram\": true,\n \"enableForum\": true,\n \"enableViewCount\": true,\n \"enableRating\": true,\n \"enableReviews\": true,\n \"showSchoolIconInMenu\": true,\n \"showIconDetails\": true,\n \"replicateInstitutionMenuLinks\": true,\n \"displaySchoolAccessButton\": true\n },\n \"contractNumber\": \"<string>\",\n \"tags\": [\n {}\n ],\n \"taxid\": \"<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://endtest.app.toolzz.com.br/api/v1/schools")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"urlSlug\": \"<string>\",\n \"groups\": [\n 123\n ],\n \"subgroups\": [\n 123\n ],\n \"specialties\": [\n 123\n ],\n \"colorScheme\": {\n \"primary\": \"<string>\",\n \"secondary\": \"<string>\",\n \"buttonText\": \"<string>\"\n },\n \"location\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"district\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"features\": {\n \"enableTeacherRegistration\": true,\n \"enableStudentRegistration\": true,\n \"enableGoogleLogin\": true,\n \"enableLoginByDocument\": true,\n \"enableLoginByEmail\": true,\n \"isPartOfProgram\": true,\n \"enableForum\": true,\n \"enableViewCount\": true,\n \"enableRating\": true,\n \"enableReviews\": true,\n \"showSchoolIconInMenu\": true,\n \"showIconDetails\": true,\n \"replicateInstitutionMenuLinks\": true,\n \"displaySchoolAccessButton\": true\n },\n \"contractNumber\": \"<string>\",\n \"tags\": [\n {}\n ],\n \"taxid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://endtest.app.toolzz.com.br/api/v1/schools")
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 \"name\": \"<string>\",\n \"urlSlug\": \"<string>\",\n \"groups\": [\n 123\n ],\n \"subgroups\": [\n 123\n ],\n \"specialties\": [\n 123\n ],\n \"colorScheme\": {\n \"primary\": \"<string>\",\n \"secondary\": \"<string>\",\n \"buttonText\": \"<string>\"\n },\n \"location\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"district\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"features\": {\n \"enableTeacherRegistration\": true,\n \"enableStudentRegistration\": true,\n \"enableGoogleLogin\": true,\n \"enableLoginByDocument\": true,\n \"enableLoginByEmail\": true,\n \"isPartOfProgram\": true,\n \"enableForum\": true,\n \"enableViewCount\": true,\n \"enableRating\": true,\n \"enableReviews\": true,\n \"showSchoolIconInMenu\": true,\n \"showIconDetails\": true,\n \"replicateInstitutionMenuLinks\": true,\n \"displaySchoolAccessButton\": true\n },\n \"contractNumber\": \"<string>\",\n \"tags\": [\n {}\n ],\n \"taxid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": 123,
"name": "<string>",
"urlSlug": "<string>",
"contractNumber": "<string>",
"tags": [
{}
],
"taxId": "<string>",
"groups": [
{
"id": 123,
"name": "<string>"
}
],
"subgroups": [
{
"id": 123,
"name": "<string>"
}
],
"specialties": [
{
"id": 123,
"name": "<string>"
}
],
"colorScheme": {
"primary": "<string>",
"secondary": "<string>",
"buttonText": "<string>"
},
"social": {
"facebook": "<string>",
"youtube": "<string>",
"instagram": "<string>"
},
"location": {
"street": "<string>",
"number": "<string>",
"additionalDetails": "<string>",
"district": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"features": {
"enableTeacherRegistration": true,
"enableStudentRegistration": true,
"enableGoogleLogin": true,
"enableLoginByDocument": true,
"enableLoginByEmail": true,
"enableForum": true,
"enableViewCounter": true,
"enableRating": true,
"isPartOfProgram": true,
"enableReviews": true,
"showSchoolIconInMenu": true,
"showIconDetails": true,
"replicateInstitutionMenuLinks": true,
"displaySchoolAccessButton": true
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
}Unidades
Criar Unidades
O endpoint de criação de unidades permite registrar informações essenciais de instituições educacionais, facilitando o processo de inserção das mesmas.
POST
/
api
/
v1
/
schools
Criar Unidades
curl --request POST \
--url https://endtest.app.toolzz.com.br/api/v1/schools \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"urlSlug": "<string>",
"groups": [
123
],
"subgroups": [
123
],
"specialties": [
123
],
"colorScheme": {
"primary": "<string>",
"secondary": "<string>",
"buttonText": "<string>"
},
"location": {
"street": "<string>",
"number": "<string>",
"district": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"features": {
"enableTeacherRegistration": true,
"enableStudentRegistration": true,
"enableGoogleLogin": true,
"enableLoginByDocument": true,
"enableLoginByEmail": true,
"isPartOfProgram": true,
"enableForum": true,
"enableViewCount": true,
"enableRating": true,
"enableReviews": true,
"showSchoolIconInMenu": true,
"showIconDetails": true,
"replicateInstitutionMenuLinks": true,
"displaySchoolAccessButton": true
},
"contractNumber": "<string>",
"tags": [
{}
],
"taxid": "<string>"
}
'import requests
url = "https://endtest.app.toolzz.com.br/api/v1/schools"
payload = {
"name": "<string>",
"urlSlug": "<string>",
"groups": [123],
"subgroups": [123],
"specialties": [123],
"colorScheme": {
"primary": "<string>",
"secondary": "<string>",
"buttonText": "<string>"
},
"location": {
"street": "<string>",
"number": "<string>",
"district": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"features": {
"enableTeacherRegistration": True,
"enableStudentRegistration": True,
"enableGoogleLogin": True,
"enableLoginByDocument": True,
"enableLoginByEmail": True,
"isPartOfProgram": True,
"enableForum": True,
"enableViewCount": True,
"enableRating": True,
"enableReviews": True,
"showSchoolIconInMenu": True,
"showIconDetails": True,
"replicateInstitutionMenuLinks": True,
"displaySchoolAccessButton": True
},
"contractNumber": "<string>",
"tags": [{}],
"taxid": "<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({
name: '<string>',
urlSlug: '<string>',
groups: [123],
subgroups: [123],
specialties: [123],
colorScheme: {primary: '<string>', secondary: '<string>', buttonText: '<string>'},
location: {
street: '<string>',
number: '<string>',
district: '<string>',
city: '<string>',
state: '<string>',
zipCode: '<string>'
},
features: {
enableTeacherRegistration: true,
enableStudentRegistration: true,
enableGoogleLogin: true,
enableLoginByDocument: true,
enableLoginByEmail: true,
isPartOfProgram: true,
enableForum: true,
enableViewCount: true,
enableRating: true,
enableReviews: true,
showSchoolIconInMenu: true,
showIconDetails: true,
replicateInstitutionMenuLinks: true,
displaySchoolAccessButton: true
},
contractNumber: '<string>',
tags: [{}],
taxid: '<string>'
})
};
fetch('https://endtest.app.toolzz.com.br/api/v1/schools', 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://endtest.app.toolzz.com.br/api/v1/schools",
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([
'name' => '<string>',
'urlSlug' => '<string>',
'groups' => [
123
],
'subgroups' => [
123
],
'specialties' => [
123
],
'colorScheme' => [
'primary' => '<string>',
'secondary' => '<string>',
'buttonText' => '<string>'
],
'location' => [
'street' => '<string>',
'number' => '<string>',
'district' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zipCode' => '<string>'
],
'features' => [
'enableTeacherRegistration' => true,
'enableStudentRegistration' => true,
'enableGoogleLogin' => true,
'enableLoginByDocument' => true,
'enableLoginByEmail' => true,
'isPartOfProgram' => true,
'enableForum' => true,
'enableViewCount' => true,
'enableRating' => true,
'enableReviews' => true,
'showSchoolIconInMenu' => true,
'showIconDetails' => true,
'replicateInstitutionMenuLinks' => true,
'displaySchoolAccessButton' => true
],
'contractNumber' => '<string>',
'tags' => [
[
]
],
'taxid' => '<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://endtest.app.toolzz.com.br/api/v1/schools"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"urlSlug\": \"<string>\",\n \"groups\": [\n 123\n ],\n \"subgroups\": [\n 123\n ],\n \"specialties\": [\n 123\n ],\n \"colorScheme\": {\n \"primary\": \"<string>\",\n \"secondary\": \"<string>\",\n \"buttonText\": \"<string>\"\n },\n \"location\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"district\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"features\": {\n \"enableTeacherRegistration\": true,\n \"enableStudentRegistration\": true,\n \"enableGoogleLogin\": true,\n \"enableLoginByDocument\": true,\n \"enableLoginByEmail\": true,\n \"isPartOfProgram\": true,\n \"enableForum\": true,\n \"enableViewCount\": true,\n \"enableRating\": true,\n \"enableReviews\": true,\n \"showSchoolIconInMenu\": true,\n \"showIconDetails\": true,\n \"replicateInstitutionMenuLinks\": true,\n \"displaySchoolAccessButton\": true\n },\n \"contractNumber\": \"<string>\",\n \"tags\": [\n {}\n ],\n \"taxid\": \"<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://endtest.app.toolzz.com.br/api/v1/schools")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"urlSlug\": \"<string>\",\n \"groups\": [\n 123\n ],\n \"subgroups\": [\n 123\n ],\n \"specialties\": [\n 123\n ],\n \"colorScheme\": {\n \"primary\": \"<string>\",\n \"secondary\": \"<string>\",\n \"buttonText\": \"<string>\"\n },\n \"location\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"district\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"features\": {\n \"enableTeacherRegistration\": true,\n \"enableStudentRegistration\": true,\n \"enableGoogleLogin\": true,\n \"enableLoginByDocument\": true,\n \"enableLoginByEmail\": true,\n \"isPartOfProgram\": true,\n \"enableForum\": true,\n \"enableViewCount\": true,\n \"enableRating\": true,\n \"enableReviews\": true,\n \"showSchoolIconInMenu\": true,\n \"showIconDetails\": true,\n \"replicateInstitutionMenuLinks\": true,\n \"displaySchoolAccessButton\": true\n },\n \"contractNumber\": \"<string>\",\n \"tags\": [\n {}\n ],\n \"taxid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://endtest.app.toolzz.com.br/api/v1/schools")
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 \"name\": \"<string>\",\n \"urlSlug\": \"<string>\",\n \"groups\": [\n 123\n ],\n \"subgroups\": [\n 123\n ],\n \"specialties\": [\n 123\n ],\n \"colorScheme\": {\n \"primary\": \"<string>\",\n \"secondary\": \"<string>\",\n \"buttonText\": \"<string>\"\n },\n \"location\": {\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"district\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zipCode\": \"<string>\"\n },\n \"features\": {\n \"enableTeacherRegistration\": true,\n \"enableStudentRegistration\": true,\n \"enableGoogleLogin\": true,\n \"enableLoginByDocument\": true,\n \"enableLoginByEmail\": true,\n \"isPartOfProgram\": true,\n \"enableForum\": true,\n \"enableViewCount\": true,\n \"enableRating\": true,\n \"enableReviews\": true,\n \"showSchoolIconInMenu\": true,\n \"showIconDetails\": true,\n \"replicateInstitutionMenuLinks\": true,\n \"displaySchoolAccessButton\": true\n },\n \"contractNumber\": \"<string>\",\n \"tags\": [\n {}\n ],\n \"taxid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": 123,
"name": "<string>",
"urlSlug": "<string>",
"contractNumber": "<string>",
"tags": [
{}
],
"taxId": "<string>",
"groups": [
{
"id": 123,
"name": "<string>"
}
],
"subgroups": [
{
"id": 123,
"name": "<string>"
}
],
"specialties": [
{
"id": 123,
"name": "<string>"
}
],
"colorScheme": {
"primary": "<string>",
"secondary": "<string>",
"buttonText": "<string>"
},
"social": {
"facebook": "<string>",
"youtube": "<string>",
"instagram": "<string>"
},
"location": {
"street": "<string>",
"number": "<string>",
"additionalDetails": "<string>",
"district": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"features": {
"enableTeacherRegistration": true,
"enableStudentRegistration": true,
"enableGoogleLogin": true,
"enableLoginByDocument": true,
"enableLoginByEmail": true,
"enableForum": true,
"enableViewCounter": true,
"enableRating": true,
"isPartOfProgram": true,
"enableReviews": true,
"showSchoolIconInMenu": true,
"showIconDetails": true,
"replicateInstitutionMenuLinks": true,
"displaySchoolAccessButton": true
},
"createdAt": "<string>",
"updatedAt": "<string>"
}
}Parâmetros
string
required
O nome da unidade a ser criada. Deve conter no máximo 255 caracteres.
string
required
URL da unidade. Deve ser um valor único, em um formato de URL válido, com no máximo 255 caracteres.
number[]
required
Array contendo os identificadores de grupos (Nível 1 de filtros) da instituição.number[]
Array contendo os identificadores de subgrupos (Nível 2 de filtros) da instituição.number[]
Array contendo os identificadores de especialidades (Nível 3 de filtros) da instituição.object
required
Objeto contendo os valores das cores a serem utilizadas na unidade.
string
required
Cor primária da identidade visual da unidade, geralmente utilizada como cor de destaque.
string
required
Cor secundária complementar da identidade visual da unidade.
string
required
Cor do texto exibido em botões da interface.
object
required
Objeto opcional contendo os dados de localização da unidade.
string
required
Nome da rua onde a unidade está localizada.
string
required
Número do endereço da unidade.
string
required
Bairro onde a unidade está localizada.
string
required
Cidade onde a unidade está localizada.
string
required
Estado (UF) onde a unidade está localizada.
string
required
Código postal (CEP) do endereço da unidade.
object
[Inconsistência]
Objeto contendo as configurações da unidade em formato boolean.
boolean
Ativa ou desativa a opção de cadastro de professores na unidade.
boolean
Ativa ou desativa a opção de cadastro de alunos na unidade.
boolean
Ativa ou desativa o login por conta Google.
boolean
Ativa ou desativa o login utilizando número de documento.
boolean
Ativa ou desativa o login por e-mail.
boolean
Indica se a unidade pertence a um programa institucional específico.
boolean
Ativa ou desativa a funcionalidade de fórum na unidade.
boolean
Ativa ou desativa a contagem de visualizações de conteúdos.
boolean
Ativa ou desativa a funcionalidade de avaliação (nota) de conteúdos.
boolean
Ativa ou desativa a possibilidade de comentários ou resenhas.
boolean
Exibe ou oculta o ícone da escola no menu de navegação.
boolean
Exibe ou oculta detalhes visuais dos ícones associados à escola.
boolean
Ativa ou desativa a replicação dos links do menu institucional.
boolean
Exibe ou oculta o botão de acesso direto à unidade escolar.
string
Número do contrato. Deve ser um valor único, com no máximo 50 caracteres.
array
Deve ser um
array de strings, com no máximo 10 elementos.string
O CNPJ da unidade. Deve ser um CNPJ válido.
Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:
- Nome da unidade
obrigatório: Defina um nome para a sua unidade. - Slug da URL
obrigatório: Necessário caso a busca seja realizada pelo slug. - Grupos
obrigatório: ID do(s) grupo(s) da instituição a serem vinculados a essa unidade. - Esquema de cores da unidade
obrigatório: Defina os valores em hexadecimal para as cores primária, secundária e da fonte dos botões. - Configurações da unidade
obrigatório: Defina quais são os parâmetros essenciais para a sua unidade de aprendizado.
Descrição da Resposta
Abaixo está um exemplo da resposta retornada por este endpoint.boolean
Indica se a solicitação foi bem-sucedida.
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.
object
Detalhes da unidade educacional.
Show properties
Show properties
number
Identificador único da unidade.
string
Nome da unidade.
string
Slug da URL da unidade.
string
Número do contrato associado à unidade.
array
Lista de tags associadas à unidade.
string
Número de identificação fiscal (CNPJ).
array
array
array
object
object
object
object
Configurações e recursos habilitados para a unidade.
Show properties
Show properties
boolean
Indica se o cadastro de professores está habilitado.
boolean
Indica se o cadastro de alunos está habilitado.
boolean
Indica se o login via Google está habilitado.
boolean
Indica se o login via documento está habilitado.
boolean
Indica se o login via e-mail está habilitado.
boolean
Indica se o fórum está habilitado.
boolean
Indica se o contador de visualizações está habilitado.
boolean
Indica se a avaliação está habilitada.
boolean
Indica se a unidade faz parte de um programa.
boolean
Indica se as avaliações de usuários estão habilitadas.
boolean
Indica se o ícone da escola será exibido no menu.
boolean
Indica se os detalhes do ícone serão exibidos.
boolean
Indica se os links do menu da instituição serão replicados.
boolean
Indica se o botão de acesso à escola será exibido.
string
Data e hora de criação da unidade.
string
Data e hora da última atualização da unidade.