Consulta de registro

Este tópico lista as características do WebService Json de consulta de registros no banco de dados.
Este método deverá ser chamado para realizar a consulta de registros em determinadas tabelas do MentorWeb.

Nome do método: consultaDados

1. Parâmetros para chamada do WebService

Parâmetro Descrição Obrigatório Tipo Observação
campos Campos da tabela que serão retornados na consulta Sim String Informar os campos, separando cada campo por vírgula.
Exemplo: PES_NOME, PES_EMAIL
tabela Tabela mestre que será consultada Sim String Informar a tabela mestre que será consultada
joins Ligações com a tabela mestre Não String Informar as ligações com a tabela mestre
Exemplo: INNER JOIN TB_INGRESSO ON (PES_ID = ING_PESID)
LEFT JOIN TB_MESTRE_ALUNO ON (ING_ID = MAL_INGID)
filtrosComValores Filtros e respectivos valores que irão restringir a consulta. Não String Informar os campos de filtro com seus respectivos valores, separando cada campo por vírgula.
Exemplo: PES_ID = 10
agrupamento Informar os campos de agrupamento da consulta Não String São os campos que irão compor o Group By da consulta
ordenacao Informar os campos de ordenação da consulta Não String São os campos que irão compor o Order By da consulta
token Deve-se passar no cabeçalho da requisição o parâmetro token. O valor deste parâmetro é gerado pelo serviço Geração do token de segurança.


2. Exemplo de chamada do WebService

URL: http://IP:PORTA/APLICACAO/rest/ICorujaCOM/consultaDados


2.1. Exemplo da passagem de parâmetros por Json:

{
    "tabela":"TB_CONCEITO",
    "filtrosComValores":"CTO_ID IN (1,27)",
    "campos":"CTO_ID, CTO_DESCRI",
    "agrupamento":"CTO_ID, CTO_DESCRI",
    "ordenacao":"CTO_DESCRI"
}
2.2. Exemplo de chamada do WebService na linguagem PHP

<?php
header('Content-Type: text/html; charset=utf-8');
$curl = curl_init();
 
curl_setopt_array($curl, array(
    CURLOPT_PORT => "8080",
    CURLOPT_URL => "http://192.168.0.66:8080/ICoruja/rest/ICorujaCOM/consultaDados",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => '{
		"tabela":"TB_CONCEITO",
		"filtrosComValores":"CTO_ID IN (1,27)",
		"campos":"CTO_ID, CTO_DESCRI",
		"agrupamento":"CTO_ID, CTO_DESCRI",
		"ordenacao":"CTO_DESCRI"
	}',
    CURLOPT_HTTPHEADER => array(
        "cache-control: no-cache",
        "content-type: application/json",
        "postman-token: 74e6008c-0675-fb7c-87d0-23adcbeddd9a",
		"token: 4518c03023683e3f69332aaa93cf75903af7f042"
    )
));
 
$response = curl_exec($curl);
$err      = curl_error($curl);
 
curl_close($curl);
 
if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
 
?>
2.3. Exemplo de chamada do WebService no PostMan

Passando o token

Passando os demais parâmetros

3 Retorno do WebService Json



3.1. Atributos retornados do WebService para o chamador

Campo Descrição Tipo Observação
Detalhe com todos os campos da consulta (listChaveValor)
chave Campo da consulta String Retorna a descrição do campo informado na consulta
valor Valor do respectivo campo Object Retorna o valor referente ao campo descrito no atributo chave


Para obter o retorno do WebService deve-se verificar o status da requisição http.

Sempre que o status for 200, significa que o processo foi realizado com sucesso. Neste caso, o retorno é apresentado conforme o exemplo abaixo: 

{
    "listChaveValor":[
        [
            {
                "chave":"CTO_ID",
                "valor":27
            },
            {
                "chave":"CTO_DESCRI",
                "valor":"Conceito de teste"
            }
        ],
        [
            {
                "chave":"CTO_ID",
                "valor":1
            },
            {
                "chave":"CTO_DESCRI",
                "valor":"Pós-graduação - adm"
            }
        ]
    ]
}

Caso o código de status não for 200, ocorreu alguma falha. Quando ocorre alguma falha tratada, o WebService irá retornar conforme exemplo abaixo, onde o código do erro deverá ser consultado no tópico 3.2. Possíveis retornos para o chamador do WebService: 

{
    "codigoErroClass": "br.com.edusoftbase.icorujaclient.tipo.TipoErroComum",
    "codigoErro": "ICM_00404",
    "central": false
}
3.2. Possíveis retornos para o chamador do WebService

Código Descrição Observação
ICM_00400 Parâmetros inválidos Ocorre quando não foram informados os parâmetros campos, valores ou tabela.
ICM_00404 Token inválido Ocorre quando o token não foi passado ou é inválido. Lembre-se de que o token tem um período de validade definido.
Gere o token novamente, e chame novamente este WebService.
ICM_00409 Ocorreu um erro ao realizar a operação. Ocorre quando acontece um erro na instrução sql montada.
Um exemplo, seria informar um campo que não existe na tabela informada. Verifique no retorno o atributo mensagemErro para maiores detalhes.
ICM_00411 Erro de conexão com banco de dados Ocorre quando não foi possível obter a conexão com o banco de dados do MentorWeb.


  • (edição externa)