Nunciatura Provista

API Documentation V1

Atualizar Diocese

Atualiza os dados de uma diocese existente

Este endpoint é do tipo: Protected

Descrição

Atualiza os dados de uma diocese existente com as seguintes funcionalidades:

  • Verifica se a diocese existe antes de atualizar
  • Atualiza nome, tipo, estado e status da diocese
  • Valida tipo de diocese (Arquidiocese, Diocese, Prelazia, Vicariato)
  • Valida formato do estado (2 caracteres)
  • Retorna erro 404 se a diocese não for encontrada
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

PUT

URL BASE

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

ENDPOINT

/dioceses/{id}

Parâmetros do Corpo da Requisição

Parâmetro Tipo Obrigatório Descrição
name string Sim Nome da diocese (máx. 255 caracteres)
type string Sim Tipo: Arquidiocese, Diocese, Prelazia, Vicariato
state string Sim Estado (2 caracteres)
active boolean Não Status ativo da diocese

Exemplo de Requisição

{
  "name": "Arquidiocese de Campinas",
  "type": "Arquidiocese",
  "state": "SP",
  "active": true
}

Cabeçalhos

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

Respostas

Sucesso - 200

{
  "success": true,
  "data": {
    "id": 1,
    "name": "Arquidiocese de Campinas",
    "type": "Arquidiocese",
    "state": "SP",
    "active": true,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T12:00:00.000000Z"
  },
  "message": "Diocese atualizada com sucesso"
}

Nota: Apenas os campos fornecidos são atualizados. O estado deve ser informado com 2 caracteres (sigla). 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 - 422 (Dados inválidos)

{
  "success": false,
  "message": "Os dados fornecidos são inválidos.",
  "errors": {
    "name": ["O campo nome é obrigatório."],
    "type": ["O tipo selecionado é inválido."],
    "state": ["O estado deve ter exatamente 2 caracteres."]
  }
}

Erro - 401 (Token inválido)

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

Códigos de Resposta

Código Descrição
200 Diocese atualizada com sucesso
401 Token inválido ou expirado
404 Diocese não encontrada
422 Dados de validação inválidos