Nunciatura Provista

API Documentation V1

Atualizar Função Eclesiástica

Atualiza os dados de uma função eclesiástica existente

Este endpoint é do tipo: Protected

Descrição

Atualiza os dados de uma função eclesiástica existente com as seguintes funcionalidades:

  • Atualiza nome e descrição da função
  • Valida unicidade do nome (exceto o próprio registro)
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

PUT

URL BASE

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

ENDPOINT

/categories/{id}

Parâmetros do Corpo da Requisição

Parâmetro Tipo Obrigatório Descrição
name string Sim Nome da função eclesiástica (máx. 255 caracteres)
description string Não Descrição da função (máx. 500 caracteres)

Exemplo de Requisição

{
  "name": "Reitor do Seminário",
  "description": "Responsável pela administração e formação do seminário diocesano"
}

Cabeçalhos

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

Respostas

Sucesso - 200

{
  "success": true,
  "data": {
    "id": 1,
    "name": "Reitor do Seminário",
    "description": "Responsável pela administração e formação do seminário diocesano",
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T12:00:00.000000Z"
  },
  "message": "Função eclesiástica atualizada com sucesso"
}

Nota: Apenas os campos fornecidos são atualizados. O nome deve ser único no sistema.

Erro - 404 (Não encontrado)

{
  "success": false,
  "message": "Função eclesiástica não encontrada"
}

Erro - 422 (Dados inválidos)

{
  "success": false,
  "message": "Os dados fornecidos são inválidos.",
  "errors": {
    "name": ["O nome da categoria é obrigatório."],
    "description": ["A descrição não pode ter mais de 500 caracteres."]
  }
}

Erro - 401 (Token inválido)

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

Códigos de Resposta

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