Nunciatura Provista

API Documentation V1

Visualizar Diocese

Retorna os dados de uma diocese específica

Este endpoint é do tipo: Protected

Descrição

Retorna os dados completos de uma diocese específica:

  • Exibe nome, tipo, estado e status da diocese
  • Inclui timestamps de criação e atualização
  • Verifica se a diocese existe antes de retornar os dados
  • Retorna erro 404 se a diocese não for encontrada
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/dioceses/{id}

Parâmetros da URL

Parâmetro Tipo Obrigatório Descrição
id integer Sim ID único da diocese

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"
  }
}

Nota: Este endpoint retorna os dados completos da diocese, incluindo nome, tipo, estado e status. Se a diocese com o ID informado não existir, será retornado um erro 404 com a mensagem "Diocese não encontrada".

Erro - 404 (Não encontrado)

{
  "success": false,
  "message": "Diocese não encontrada"
}

Erro - 401 (Token inválido)

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

Códigos de Resposta

Código Descrição
200 Diocese retornada com sucesso
401 Token inválido ou expirado
404 Diocese não encontrada