REST

Documentação do uso das requisições de REST.

Requisição de busca de dados (Query)

POST {{url}}/private/{{v}}/account/{{account}}/rest/query/{{collection}}

Requisição utilizada para busca de informações

Headers

Name	Type	Description
Session	string	Token de sessão do usuário

Request Body

Name	Type	Description
select	string	Especifica quais campos deverão ser selecionados.
populate	array	Lista de objetos que desejam ser populados.
filters	object	Objeto com as informações de build da query

200 Liste de objetos retornados pela query.

{
    "status": "OK",
    "result": [...]
}

404 Erro ao executar a query.

Exemplo de uma busca de cursos presenciais ou híbridos, populando as turmas confirmadas e que ainda não tenham encerrado.

'POST {{url}}/private/v2/account/{{account}}/rest/query/course'
{
    //Opções de filtro da busca por cursos
    filters: {
        //Cursos cujo campo `classroom.type` seja um dos valores listado
        'classroom.type': {
            '$in': ['presential', 'hybrid']
        }
    },
    //Lista de campos dos cursos que devem ser populados
    populate: [{
        //Para o campo do curso `__classes`
        path: '__classes',
        //Busca as turmas desse curso que estejam confirmadas e que ainda não tenham encerrado
        match: {
            'status.general': 'confirmed',
            'seasons.end': {
                '$gt': new Date()
            }
        },
        //Seleciona somente o nome da turma
        select: 'info.name'
    },{
        //Popula também o campo do curso `media._banner`
        path: 'media._banner'
    }],
    //Seleciona o campo `mainInfo`
    //PS: Campos populados já serão selecionados por padrão
    select: 'mainInfo'
}