Nunciatura Provista

API Documentation V1

Criar Diocese

Cria uma nova diocese no sistema

Este endpoint é do tipo: Protected

Descrição

Cria uma nova diocese no sistema com as seguintes funcionalidades:

  • Cadastra nome, tipo, estado e status da diocese
  • Valida tipo de diocese (Arquidiocese, Diocese, Prelazia, Vicariato)
  • Valida formato do estado (2 caracteres)
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

POST

URL BASE

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

ENDPOINT

/dioceses

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 (padrão: true)

Exemplo de Requisição

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

Cabeçalhos

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

Respostas

Sucesso - 201

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

Nota: A diocese é criada com status ativo por padrão. O estado deve ser informado com 2 caracteres (sigla).

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