Gerar Seções Embedáveis

curl --request POST \
  --url https://kong.api.toolzz.com.br/catalog/secao \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "school": "<string>",
  "content_type": [
    {}
  ],
  "groups": [
    {}
  ],
  "subgroups": [
    {}
  ],
  "specialties": [
    {}
  ],
  "order": [
    {}
  ],
  "criteria": 123,
  "orientation": 123,
  "status": 123,
  "content_attributes": 123,
  "manual": [
    {}
  ]
}
'

import requests

url = "https://kong.api.toolzz.com.br/catalog/secao"

payload = {
    "name": "<string>",
    "description": "<string>",
    "school": "<string>",
    "content_type": [{}],
    "groups": [{}],
    "subgroups": [{}],
    "specialties": [{}],
    "order": [{}],
    "criteria": 123,
    "orientation": 123,
    "status": 123,
    "content_attributes": 123,
    "manual": [{}]
}
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>',
    description: '<string>',
    school: '<string>',
    content_type: [{}],
    groups: [{}],
    subgroups: [{}],
    specialties: [{}],
    order: [{}],
    criteria: 123,
    orientation: 123,
    status: 123,
    content_attributes: 123,
    manual: [{}]
  })
};

fetch('https://kong.api.toolzz.com.br/catalog/secao', 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/catalog/secao",
  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>',
    'description' => '<string>',
    'school' => '<string>',
    'content_type' => [
        [
                
        ]
    ],
    'groups' => [
        [
                
        ]
    ],
    'subgroups' => [
        [
                
        ]
    ],
    'specialties' => [
        [
                
        ]
    ],
    'order' => [
        [
                
        ]
    ],
    'criteria' => 123,
    'orientation' => 123,
    'status' => 123,
    'content_attributes' => 123,
    'manual' => [
        [
                
        ]
    ]
  ]),
  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/catalog/secao"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"school\": \"<string>\",\n  \"content_type\": [\n    {}\n  ],\n  \"groups\": [\n    {}\n  ],\n  \"subgroups\": [\n    {}\n  ],\n  \"specialties\": [\n    {}\n  ],\n  \"order\": [\n    {}\n  ],\n  \"criteria\": 123,\n  \"orientation\": 123,\n  \"status\": 123,\n  \"content_attributes\": 123,\n  \"manual\": [\n    {}\n  ]\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/catalog/secao")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"school\": \"<string>\",\n  \"content_type\": [\n    {}\n  ],\n  \"groups\": [\n    {}\n  ],\n  \"subgroups\": [\n    {}\n  ],\n  \"specialties\": [\n    {}\n  ],\n  \"order\": [\n    {}\n  ],\n  \"criteria\": 123,\n  \"orientation\": 123,\n  \"status\": 123,\n  \"content_attributes\": 123,\n  \"manual\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://kong.api.toolzz.com.br/catalog/secao")

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  \"description\": \"<string>\",\n  \"school\": \"<string>\",\n  \"content_type\": [\n    {}\n  ],\n  \"groups\": [\n    {}\n  ],\n  \"subgroups\": [\n    {}\n  ],\n  \"specialties\": [\n    {}\n  ],\n  \"order\": [\n    {}\n  ],\n  \"criteria\": 123,\n  \"orientation\": 123,\n  \"status\": 123,\n  \"content_attributes\": 123,\n  \"manual\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

POST

catalog

secao

Gerar Seções Embedáveis

curl --request POST \
  --url https://kong.api.toolzz.com.br/catalog/secao \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "school": "<string>",
  "content_type": [
    {}
  ],
  "groups": [
    {}
  ],
  "subgroups": [
    {}
  ],
  "specialties": [
    {}
  ],
  "order": [
    {}
  ],
  "criteria": 123,
  "orientation": 123,
  "status": 123,
  "content_attributes": 123,
  "manual": [
    {}
  ]
}
'

import requests

url = "https://kong.api.toolzz.com.br/catalog/secao"

payload = {
    "name": "<string>",
    "description": "<string>",
    "school": "<string>",
    "content_type": [{}],
    "groups": [{}],
    "subgroups": [{}],
    "specialties": [{}],
    "order": [{}],
    "criteria": 123,
    "orientation": 123,
    "status": 123,
    "content_attributes": 123,
    "manual": [{}]
}
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>',
    description: '<string>',
    school: '<string>',
    content_type: [{}],
    groups: [{}],
    subgroups: [{}],
    specialties: [{}],
    order: [{}],
    criteria: 123,
    orientation: 123,
    status: 123,
    content_attributes: 123,
    manual: [{}]
  })
};

fetch('https://kong.api.toolzz.com.br/catalog/secao', 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/catalog/secao",
  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>',
    'description' => '<string>',
    'school' => '<string>',
    'content_type' => [
        [
                
        ]
    ],
    'groups' => [
        [
                
        ]
    ],
    'subgroups' => [
        [
                
        ]
    ],
    'specialties' => [
        [
                
        ]
    ],
    'order' => [
        [
                
        ]
    ],
    'criteria' => 123,
    'orientation' => 123,
    'status' => 123,
    'content_attributes' => 123,
    'manual' => [
        [
                
        ]
    ]
  ]),
  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/catalog/secao"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"school\": \"<string>\",\n  \"content_type\": [\n    {}\n  ],\n  \"groups\": [\n    {}\n  ],\n  \"subgroups\": [\n    {}\n  ],\n  \"specialties\": [\n    {}\n  ],\n  \"order\": [\n    {}\n  ],\n  \"criteria\": 123,\n  \"orientation\": 123,\n  \"status\": 123,\n  \"content_attributes\": 123,\n  \"manual\": [\n    {}\n  ]\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/catalog/secao")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"school\": \"<string>\",\n  \"content_type\": [\n    {}\n  ],\n  \"groups\": [\n    {}\n  ],\n  \"subgroups\": [\n    {}\n  ],\n  \"specialties\": [\n    {}\n  ],\n  \"order\": [\n    {}\n  ],\n  \"criteria\": 123,\n  \"orientation\": 123,\n  \"status\": 123,\n  \"content_attributes\": 123,\n  \"manual\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://kong.api.toolzz.com.br/catalog/secao")

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  \"description\": \"<string>\",\n  \"school\": \"<string>\",\n  \"content_type\": [\n    {}\n  ],\n  \"groups\": [\n    {}\n  ],\n  \"subgroups\": [\n    {}\n  ],\n  \"specialties\": [\n    {}\n  ],\n  \"order\": [\n    {}\n  ],\n  \"criteria\": 123,\n  \"orientation\": 123,\n  \"status\": 123,\n  \"content_attributes\": 123,\n  \"manual\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

Parâmetros

string

required

Nome da nova seção a ser criada.

string

Descrição da seção.

string

Identificador único da escola, permitindo a criação de seções exclusivas para cada unidade.

array

required

Array obrigatório que define os tipos de conteúdo a serem incluídos na seção.

array

Array opcional contendo strings ou IDs dos grupos existentes. Os nomes ou IDs devem corresponder exatamente aos grupos já cadastrados.

array

Array opcional contendo strings ou IDs dos subgrupos. Os nomes ou IDs devem corresponder exatamente aos subgrupos existentes e relacionados aos grupos.

array

Array opcional contendo strings ou IDs das especialidades. Os nomes ou IDs devem corresponder às especialidades existentes e relacionadas aos subgrupos.

array

Array contendo objetos com as propriedades criteria e orientation para definir a ordenação dos itens na seção.

int

alphabetical = 1 | creation_date = 2 | price = 3 | random = 4

int

crescent = 1 | decrescent = 2

int

required

active = 1 | inactive = 2

int

1 = Popularidade (os mais acessados)
2 = Avaliações (os mais bem avaliados)
3 = Novidades (os criados mais recentemente)
4 = Manual (IDs específicos)

array

Se content_attributes for 4, deve ser incluído um array “manual” com os IDs dos itens desejados (máximo de 10 itens).

Para utilizar este recurso, é necessário possuir a feature “Provas Classificatórias” ativa na plataforma.

Antes de utilizar este endpoint, certifique-se de possuir o seguinte parâmetro disponível:

Detalhes dos parâmetros de requisição:

Token de acesso obrigatório: Certifique-se de possuir um token de autenticação válido antes de prosseguir.
name obrigatório: Nome da nova seção.
description: Descrição da seção.
school: Identificador da escola para criação de seções exclusivas da unidade.
content_type obrigatório: Array indicando os tipos de conteúdos. Opções:
- courses = 1
- components = 2
- trail = 3
- learning_object = 4
- video = 5
- audio = 6
- album = 7
- pdf = 8
- text = 9
- package = 10
groups: Array de strings ou IDs, representando os grupos associados.
subgroups: Array de strings ou IDs, representando os subgrupos associados.
specialties: Array de strings ou IDs, representando as especialidades associadas.
order: Array de objetos para definir a ordenação dos itens na seção, com dois campos:
- criteria: Inteiro para o critério de ordenação. Opções:
  - alphabetical = 1 (padrão)
  - creation_date = 2
  - price = 3
  - random = 4
- orientation: Inteiro para a orientação da ordenação. Opções:
  - crescent = 1
  - decrescent = 2
status obrigatório: Inteiro para definir o status da seção. Opções:
- active = 1
- inactive = 2
content_attributes: Inteiro para definir o critério de seleção de itens para a seção:
- 1: Popularidade (os mais acessados)
- 2: Avaliações (os mais bem avaliados)
- 3: Novidades (os mais recentes)
- 4: Manual (IDs específicos)
  - Se content_attributes for 4, incluir o objeto manual com um array de IDs (máximo de 10 itens).

Toolzz LMS API reference

Webhooks

Gerar Seções Embedáveis

Parâmetros

Detalhes dos parâmetros de requisição:

​Parâmetros

​Detalhes dos parâmetros de requisição:

Parâmetros

Detalhes dos parâmetros de requisição: