Nunciatura Provista

API Documentation V1

Excluir Diocese

Remove uma diocese do sistema

Este endpoint é do tipo: Protected

Descrição

Remove uma diocese do sistema com as seguintes funcionalidades:

  • Verifica se a diocese existe antes de excluir
  • Exclui permanentemente a diocese
  • Verifica se a diocese está sendo utilizada por informadores
  • Bloqueia exclusão se houver dependências
  • Retorna erro 404 se a diocese não for encontrada
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

DELETE

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,
  "message": "Diocese excluída com sucesso"
}

Nota: A exclusão é permanente e só é permitida se a diocese não estiver sendo utilizada por informadores. Se a diocese com o ID informado não existir, será retornado um erro 404 com a mensagem "Diocese não encontrada".

Erro - 422 (Em uso)

{
  "success": false,
  "message": "Não é possível excluir esta diocese pois está sendo utilizada por informadores"
}

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 excluída com sucesso
401 Token inválido ou expirado
404 Diocese não encontrada
422 Diocese está sendo utilizada por informadores