Pular para o conteúdo principal

Dados monitoramento

Este endpoint retorna todos os dados coletados de um processo previamente cadastrado para monitoramento, independentemente de o cliente já ter confirmado o recebimento das informações via callback.

Atenção

A propriedade confirmed indica se determinada informação já foi confirmada pelo cliente.

Quando confirmed: true, significa que o dado já foi entregue e confirmado, não sendo reenviado via callback.

Requisição

GET https://api.push.codilo.com.br/v1/processo/dados/{processoId}

Parâmetros

NomeTipoObrigatórioDescrição
processoIdstringtrueID do processo cadastrado

Exemplos de Requisição

curl --request GET \
--url https://api.push.codilo.com.br/v1/processo/dados/49409db8-aef0-4ed7-b679-170055a63ff3 \
--header 'Authorization: Bearer SEU_ACCESS_TOKEN'

Exemplo de Resposta (200 - OK)

{
"success": true,
"data": {
"id": "49409db8-aef0-4ed7-b679-170055a63ff3",
"cnj": "0001716-28.1990.8.11.0003",
"createdAt": "2022-03-10T20:31:53.427Z",
"info": [
{
"id": "d0af2a37-ed4e-485b-ad60-1fb0760ae35b",
"source": "Consulta de Tribunais",
"platform": "Tribunais Superiores",
"search": "Conselho Nacional de Justiça",
"query": "Consulta de Processos Unificada",
"lastStatus": "success",
"lastResponse": "2023-07-12T15:31:09.500Z",
"data": [
{
"cover": [],
"propertiesArray": [],
"people": [],
"steps": []
}
]
}
]
}
}

Status Codes

StatusSignificadoDescrição
200OKDados retornados com sucesso
401UnauthorizedToken inválido ou não informado
500Internal Server ErrorErro interno da aplicação

Estrutura da Resposta

A resposta contém um array com todas as informações coletadas nas diferentes fontes consultadas. Cada fonte pode retornar os seguintes grupos de dados:

Capa do Processo (cover)

{
"cover": [
{
"id": "uuidV4",
"description": "string",
"value": "string",
"confirmed": "boolean"
}
]
}

Campos:

  • id: Identificador único do registro
  • description: Nome do campo (ex: Classe, Assunto, Vara)
  • value: Valor coletado
  • confirmed: Indica se o cliente já confirmou o recebimento

Propriedades do Processo (propertiesArray)

{
"propertiesArray": [
{
"id": "uuidV4",
"key": "string",
"value": "string",
"confirmed": "boolean"
}
]
}

Campos:

  • key: Identificador lógico do campo
  • value: Valor associado
  • confirmed: Indica se o cliente já confirmou o recebimento

Partes do Processo (people)

{
"people": [
{
"id": "uuidV4",
"pole": "string",
"description": "string",
"name": "string",
"lawyers": [
{
"name": "string",
"oab": "123",
"uf": "SP"
}
],
"confirmed": "boolean"
}
]
}

Campos:

  • pole: Polo processual (ex: active, passive, alternative)
  • description: Papel da parte (ex: Autor, Réu)
  • lawyers: Lista de advogados vinculados
  • confirmed: Indica se o cliente já confirmou o recebimento

Andamentos do Processo (steps)

{
"steps": [
{
"id": "uuidV4",
"title": "string",
"description": "string",
"files": [],
"confirmed": "boolean"
}
]
}

Campos:

  • title: Título do andamento
  • description: Descrição detalhada
  • files: Arquivos vinculados ao andamento
  • confirmed: Indica se o cliente já confirmou o recebimento