HomeGuides
API Reference

Consultas

Como obter as informações de todas as consultas de um relatório ?

Para obter todas as consultas realizadas de um relatório anteriormente criado, basta realizar uma simples requisição com o método GET para nossa API no seguinte endpoint: https://api-v2.idwall.co/relatorios/{numero_do_relatorio}/consultas substituindo o parâmetro {numero_do_relatorio} pelo real número do relatório como mostra o exemplo abaixo.

curl -X GET https://api-v2.idwall.co/relatorios/numero_relatorio/consultas 
-H "Content-Type: application/json" 
-H 'Authorization:seu-token'

Exemplo de sucesso

{
  "result": {
    "nome_matriz": "consultaPessoaDefault",
    "status_protocolo": "CONCLUIDO",
    "consultas": [
      {
        "nome": "Protestos",
        "tentativas": [
          {
            "duracao_tentativa": 296.005,
            "hora_fim_tentativa": "2018-11-19T19:39:42.967Z",
            "hora_inicio_tentativa": "2018-11-19T19:34:46.962Z",
            "msg_erro_tentativa": "",
            "nome_fonte": "Protestos",
            "status_fonte": "OK",
            "status_tentativa": "SUCCESS",
            "tipo_erro_tentativa": null
          }
        ]
      },
      {
        "nome": "Antecedentes Federal",
        "tentativas": [
          {
            "duracao_tentativa": 4.575,
            "hora_fim_tentativa": "2018-11-19T19:34:51.538Z",
            "hora_inicio_tentativa": "2018-11-19T19:34:46.963Z",
            "msg_erro_tentativa": "",
            "nome_fonte": "Antecedentes Federal",
            "status_fonte": "OK",
            "status_tentativa": "SUCCESS",
            "tipo_erro_tentativa": null
          }
        ]
      },
      {
        "nome": "Processos SP",
        "tentativas": [
          {
            "duracao_tentativa": 4,
            "hora_fim_tentativa": "2018-11-19T19:34:50.986Z",
            "hora_inicio_tentativa": "2018-11-19T19:34:46.986Z",
            "msg_erro_tentativa": "",
            "nome_fonte": "Processos SP",
            "status_fonte": "OK",
            "status_tentativa": "SUCCESS",
            "tipo_erro_tentativa": null
          }
        ]
      },
      {
        "nome": "CPF Receita Federal",
        "tentativas": [
          {
            "duracao_tentativa": 1.896,
            "hora_fim_tentativa": "2018-11-19T19:34:48.859Z",
            "hora_inicio_tentativa": "2018-11-19T19:34:46.963Z",
            "msg_erro_tentativa": "",
            "nome_fonte": "CPF Receita Federal",
            "status_fonte": "OK",
            "status_tentativa": "SUCCESS",
            "tipo_erro_tentativa": null
          }
        ]
      }
    ]
  },
  "status_code": 200
}

🚧

O resultado retornado por esta rota varia conforme a matriz que é utilizada no momento da criação do relatório.

Tabela de resultado possíveis para o parâmetro tipo_erro_tentativa:

Tipo de erroDescrição
INTERNAL_ERROROcorreu um erro interno na fonte no momento da consulta.
INVALID_DATA_ERRORTodos os dados enviados estão corretos, mas a fonte retornou um resultado inesperado.
Ex.: "Veículo não encontrado na base", "CPF válido porém não consta na fonte".
INPUT_ERRORAlguns parâmetros enviados não eram esperados como resposta.
Ex .: CPF fora do padrão aceitável (AAANNN515); Nome inválido (com dígitos em sua composição - "Maria123"); Sobrenome não enviado; etc.

📘

Quantas vezes tentamos acessar as fontes ?

Nós tentamos acessar todas as fontes de consultada da sua matriz 5 vezes, caso as 5 tentativas retorne erro o relatório aparecerá com o status em análise.

Exemplo de erro

{
  "error": "Unauthorized",
  "message": "Falha na autenticação. Por favor verifique o token utilizado e se o acesso foi liberado.",
  "status_code": 401
}

{
  "error": "Not Found",
  "message": "Protocolo não encontrado.",
  "status_code": 404
}

Updated over 5 years ago

What’s Next