Nunciatura Provista

API Documentation V1

Criar Função Eclesiástica

Cria uma nova função eclesiástica no sistema

Este endpoint é do tipo: Protected

Descrição

Cria uma nova função eclesiástica no sistema com as seguintes funcionalidades:

  • Cadastra nome e descrição da função eclesiástica
  • Valida unicidade do nome da função
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

POST

URL BASE

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

ENDPOINT

/categories

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

Cabeçalhos

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

Respostas

Sucesso - 201

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

Nota: A função eclesiástica é criada com status ativo por padrão e o nome deve ser único no sistema.

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
201 Função eclesiástica criada com sucesso
401 Token inválido ou expirado
422 Dados de validação inválidos