Visualizar por ID

Este endpoint retorna a lista de requisições individuais geradas a partir de uma consulta automática.

⚠️ Os dados processuais coletados não são retornados nesta rota.
Para obter as informações completas de uma requisição com status success, utilize o endpoint de visualizar consulta por ID na consulta única informando o id da requisição desejada.

Requisição

GET https://api.consulta.codilo.com.br/v1/autorequest/{autoRequestId}

Parâmetros

Nome	Tipo	Obrigatório	Descrição
autoRequestId	string	true	Identificador da consulta automática gerada

Exemplos de Requisição

cURL

curl -X GET "https://api.consulta.codilo.com.br/v1/autorequest/c5c42bbe-7fa8-44d7-9d78-a8c89e821dd9" \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN"

Python

import requests

headers = {
    "Authorization": "Bearer SEU_ACCESS_TOKEN"
}

response = requests.get(
    "https://api.consulta.codilo.com.br/v1/autorequest/c5c42bbe-7fa8-44d7-9d78-a8c89e821dd9",
    headers=headers
)

print(response.json())

PHP

<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.consulta.codilo.com.br/v1/autorequest/c5c42bbe-7fa8-44d7-9d78-a8c89e821dd9');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer SEU_ACCESS_TOKEN",
]);

$response = curl_exec($ch);

curl_close($ch);

echo $response;

Node.js

fetch("https://api.consulta.codilo.com.br/v1/autorequest/c5c42bbe-7fa8-44d7-9d78-a8c89e821dd9", {
  method: "GET",
  headers: {
    Authorization: "Bearer SEU_ACCESS_TOKEN",
  },
})
  .then(response => response.json())
  .then(data => console.log(data));

Status das Requisições

Cada item dentro da propriedade requests possui um campo status, que indica o estado atual do processamento:

Status	Descrição
pending	A consulta está em processamento
success	Dados encontrados e coletados com sucesso
warning	Nenhum dado encontrado (processo inexistente, migrado, segredo de justiça, etc.)
error	Erro durante a coleta (indisponibilidade do tribunal ou falha interna)

Exemplo de Resposta (200 - OK)

Sucesso

{
  "success": true,
  "data": {
    "id": "c5c42bbe-7fa8-44d7-9d78-a8c89e821dd9",
    "key": "cnj",
    "value": "0804495-71.2018.8.10.0001",
    "requests": [
      {
        "id": "471fd997-fa85-479e-a3a8-97d8391537bf",
        "status": "pending",
        "platform": "jurisconsult",
        "query": "principal",
        "court": "tjma"
      },
      {
        "id": "f2a9a200-c742-43e1-820c-a008e37ddce3",
        "status": "success",
        "platform": "pje",
        "query": "principal",
        "court": "tjma"
      }
    ],
    "createdAt": "2022-03-08T01:06:42.664Z"
  }
}

Status Codes

Status	Significado	Descrição
200	OK	Consulta automática localizada com sucesso
401	Unauthorized	Token inválido, expirado ou não informado
429	Too Many Requests	Limite de requisições excedido