Listar Processos

Retorna uma lista de processos de provisão eclesiástica

Este endpoint é do tipo: Protected

Descrição

Retorna uma lista de processos de provisão com as seguintes funcionalidades:

Lista todos os processos de provisão eclesiástica
Inclui protocolo no formato PROV-YYYY-XXX
Mostra status do processo (A iniciar, Em andamento, Concluído)
Informações sobre usuários coletados vs total de usuários
Paginação: Controle de página e itens por página
Filtros: Por status e busca textual
Ordenação: Por qualquer campo em ordem crescente ou decrescente
Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

GET

URL BASE

http://api.provista.hmg.nabrasil.org.br/v1

ENDPOINT

/processes

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
page	integer	Não	Número da página (padrão: 1)
per_page	integer	Não	Itens por página (padrão: 12)
status	string	Não	Filtrar por status: "A iniciar", "Em andamento", "Concluído"
search	string	Não	Buscar por nome, protocolo ou descrição
sort_by	string	Não	Campo para ordenação (padrão: created_at)
sort_order	string	Não	Direção da ordenação: "asc" ou "desc" (padrão: desc)

Cabeçalhos

Parâmetro	Valor
Authorization	Bearer <token>
Accept	application/json

Respostas

Sucesso - 200

{
  "success": true,
  "data": [
    {
      "id": "uuid-processo-1",
      "name": "Arquidiocese de São Paulo",
      "protocol": "PROV-2024-001",
      "description": "Processo de provisão para a Arquidiocese de São Paulo",
      "initials": "AS",
      "informers_total": 25,
      "answers": {
        "received": 18,
        "expected": 300,
        "label": "18/300"
      },
      "status": "Em andamento",
      "groups_summary": [
        {
          "id": "uuid-grupo-1",
          "code": "G1",
          "name": "Grupo 1",
          "color": "#845ADF",
          "informers_count": 25,
          "questionnaires_count": 3,
          "answers_received": 12,
          "answers_expected": 75
        },
        {
          "id": "uuid-grupo-2",
          "code": "G2",
          "name": "Grupo 2",
          "color": "#26BF94",
          "informers_count": 25,
          "questionnaires_count": 1,
          "answers_received": 3,
          "answers_expected": 25
        },
        {
          "id": "uuid-grupo-3",
          "code": "G3",
          "name": "Grupo 3",
          "color": "#F5B849",
          "informers_count": 25,
          "questionnaires_count": 1,
          "answers_received": 2,
          "answers_expected": 25
        },
        {
          "id": "uuid-grupo-4",
          "code": "G4",
          "name": "Grupo 4",
          "color": "#E6533C",
          "informers_count": 25,
          "questionnaires_count": 1,
          "answers_received": 1,
          "answers_expected": 25
        },
        {
          "id": "uuid-grupo-5",
          "code": "G5",
          "name": "Grupo 5",
          "color": "#49B6F5",
          "informers_count": 25,
          "questionnaires_count": 1,
          "answers_received": 0,
          "answers_expected": 25
        },
        {
          "id": "uuid-grupo-6",
          "code": "G6",
          "name": "Grupo 6",
          "color": "#7987A1",
          "informers_count": 25,
          "questionnaires_count": 1,
          "answers_received": 0,
          "answers_expected": 25
        }
      ],
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-01-15T10:30:00.000000Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 12,
    "total": 25,
    "last_page": 3,
    "from": 1,
    "to": 12,
    "has_more_pages": true
  }
}

Erro - 401 (Token inválido)

{
  "success": false,
  "message": "Token não fornecido"
}

Códigos de Resposta

Código	Descrição
200	Lista de processos retornada com sucesso
401	Token inválido ou expirado

Nunciatura Provista