Ir para o conteúdo

Métodos de listagem

Assim como descrito na seção de autenticação, os métodos de listagem também utilizam os atributos origem e token para a autenticação do usuário no sistema.

Atributos Tipo Obrigatoriedade Descrição
origem integer Sim Código de identificação do canal.
token string Sim Chave de acesso única referente ao canal.

Listar níveis de ensino

POSTapplication/json /api/Registro/listarNiveisEnsino

Método utilizado para listar os níveis de ensino para posteriormente utilizar como parâmetro em outro método.

1
2
3
4
5
6
7
8
{
    "success": true,
    "dados": [{
        "id": "1",
        "codigo": "1",
        "titulo": "Graduação"
    }]
}

Listar tipos do contato

POSTapplication/json /api/Registro/listarTiposContato

Método utilizado para listar os tipos de contatos para posteriormente utilizar como parâmetro em outro método.

1
2
3
4
5
6
7
{
    "success": true,
    "dados": [{
        "id": "1",
        "titulo": "Aluno"
    }]
}

Listar deficiências

POSTapplication/json /api/Contato/listarDeficiencias

Método utilizado para listar os tipos de deficiências para posteriormente utilizar como parâmetro em outro método.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
    "success": true,
    "dados": [{
        "id": "1",
        "nome": "Deficiente F\u00edsico",
        "tipos": [{
            "id": "1",
            "nome": "Paraplegia"
        }, {
            "id": "2",
            "nome": "Tetraplegia"
        }, {
            "id": "3",
            "nome": "Hemiplegia"
        }, {
            "id": "4",
            "nome": "Paralisia Cerebral"
        }, {
            "id": "5",
            "nome": "Amputa\u00e7\u00e3o"
        }, {
            "id": "6",
            "nome": "Defici\u00eancia F\u00edsica"
        }, {
            "id": "7",
            "nome": "Defici\u00eancia M\u00faltipla"
        }]
    }]
}

Listar usuários

POSTapplication/json /api/Usuario/listarUsuarios

Atributos Tipo Obrigatoriedade Descrição
ids array[] Não Filtrar por id para retornar somente os usuários enviados, se o campo for enviado vazio, todos serão considerados.
retornarPermissoes integer Não Campo passado para se ter o retorno das permissões detalhadas dos usuários.
Padrão: 0 ou 1
origem integer Sim Código de identificação do canal.
token string Sim Chave de acesso única referente ao canal.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    "success": true,
    "dados": [{
        "id": "1",
        "nome": "Nome do usuário",
        "email": "emailusuario@rubeus.com.br",
        "administrador": "1",
        "liderVendas": "0",
        "vendedor": "0"
    }]
}

Listar logs da API

POSTapplication/json /api/Log/listarLogs

Atributos Tipo Obrigatoriedade Descrição
metodo string Não Retornar os logs somente do método enviado, caso não seja enviado nenhum, todos serão considerados.
Exemplo: "Contato/cadastro"
de date Condicional Data inicial de retorno, deve ser enviado caso seja enviado o campo "ate"
ate date Condicional Data final de retorno, deve ser enviado caso seja enviado o campo "de"
origemFiltro integer Não Retornar os logs somente da origem enviada, caso não seja enviado nenhuma, todas serão consideradas
origem integer Sim Código de identificação do canal.
token string Sim Chave de acesso única referente ao canal.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "success": true,
    "dados": [{
        "dados": "JSON com os dados enviados",
        "resposta": "{\"success\":true,\"dados\":1}",
        "metodo": "Pessoa/cadastro",
        "sucesso": "1",
        "origem": "3",
        "origemNome": "Ficha de inscrição",
        "momento": "2018-12-04 15:14:14"
    }]
}

Listar cidades

POSTapplication/json /api/Contato/listarCidade

Método utilizado para listar as cidades para posteriormente utilizar como parâmetro em outro método.

1
2
3
4
5
6
7
8
9
{
    "resultado": {
        "success": true,
        "dados": [{
            "id": "79",
            "titulo": "Acrelândia - AC"
        }]
    }
}