Listar Dioceses

Retorna uma lista de dioceses do sistema

Este endpoint é do tipo: Protected

Descrição

Retorna uma lista de dioceses com as seguintes funcionalidades:

Lista todas as dioceses cadastradas no sistema
Inclui nome, tipo, estado e status de cada diocese
Filtros por status ativo/inativo, estado e tipo
Busca por nome da diocese
Paginação com 12 itens por página (padrão)
Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/dioceses

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
active	boolean	Não	Filtrar por status ativo (true/false)
state	string	Não	Filtrar por estado (2 caracteres)
type	string	Não	Filtrar por tipo (Arquidiocese, Diocese, Prelazia, Vicariato)
search	string	Não	Buscar por nome da diocese
page	integer	Não	Número da página (padrão: 1)
per_page	integer	Não	Itens por página (padrão: 12)

Cabeçalhos

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

Respostas

Sucesso - 200

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Arquidiocese de São Paulo",
      "type": "Arquidiocese",
      "state": "SP",
      "active": true,
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-01-01T00:00:00.000000Z"
    },
    {
      "id": 2,
      "name": "Diocese de Santos",
      "type": "Diocese",
      "state": "SP",
      "active": true,
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-01-01T00:00:00.000000Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 12,
    "total": 50,
    "last_page": 5,
    "from": 1,
    "to": 12,
    "has_more_pages": true
  }
}

Nota: Este endpoint retorna dados paginados com 12 itens por página (padrão). Use os parâmetros page e per_page para navegar e customizar a paginação.

Erro - 401 (Token inválido)

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

Códigos de Resposta

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

Nunciatura Provista