Nunciatura Provista

API Documentation V1

Criar Processo

Cria um novo processo de provisão eclesiástica

Este endpoint é do tipo: Protected

Descrição

Cria um novo processo de provisão com as seguintes funcionalidades:

  • Cria automaticamente 6 grupos eclesiásticos vinculados ao processo (Grupos 1 a 6)
  • Normaliza automaticamente o nome do processo
  • Valida unicidade do nome e protocolo
  • Protocolo e descrição são opcionais
  • Retorna o processo criado com seus grupos relacionados
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

POST

URL BASE

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

ENDPOINT

/processes

Cabeçalhos

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

Corpo da Requisição

Campo Tipo Obrigatório Descrição
name string Sim Nome do processo (máx: 255 caracteres, único, será normalizado automaticamente)
protocol string Não Protocolo do processo (máx: 255 caracteres, único, opcional)
description string Não Descrição detalhada do processo (opcional)

Exemplo de Requisição

{
  "name": "diocese de são paulo",
  "protocol": "PROV-2024-001",
  "description": "Processo de provisão para Diocese de São Paulo"
}

Nota: Apenas o campo name é obrigatório. O nome será normalizado automaticamente para "Diocese de São Paulo".

Respostas

Sucesso - 201

{
  "success": true,
  "message": "Processo criado com sucesso",
  "data": {
    "id": "uuid-processo-1",
    "name": "Diocese de São Paulo",
    "protocol": "PROV-2024-001",
    "description": "Processo de provisão para Diocese de São Paulo",
    "groups": [
      {
        "id": "uuid-g1",
        "name": "Grupo 1",
        "color": "#845ADF",
        "description": "Bispo em saída/transferido",
        "process_id": "uuid-processo-1",
        "questionnaires": [
          {"id": "uuid-q1", "title": "Indicação de informadores", "indicator": "g1q1", "can_be_shared": false, "status": "Não iniciado"},
          {"id": "uuid-q2", "title": "Perfil da Diocese", "indicator": "g1q2", "can_be_shared": false, "status": "Não iniciado"},
          {"id": "uuid-q3", "title": "Terna de candidatos", "indicator": "g1q3", "can_be_shared": false, "status": "Não iniciado"}
        ]
      },
      {
        "id": "uuid-g2",
        "name": "Grupo 2",
        "color": "#26BF94",
        "description": "Cardeais, Presidência da CNBB e Bispos Eméritos",
        "process_id": "uuid-processo-1",
        "questionnaires": [
          {"id": "uuid-q4", "title": "Questionário - Grupo 2", "indicator": "g2q1", "can_be_shared": false, "status": "Não iniciado"}
        ]
      }
    ],
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

Nota: O processo é criado automaticamente com 6 grupos (G1 a G6) vinculados a ele.

Erro - 422 (Validação)

{
  "success": false,
  "message": "Erro de validação",
  "errors": {
    "name": ["O nome do processo é obrigatório."],
    "name": ["Este nome já está cadastrado no sistema."],
    "protocol": ["Este protocolo já está cadastrado no sistema."]
  }
}

Erro - 401 (Token inválido)

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

Códigos de Resposta

Código Descrição
201 Processo criado com sucesso
401 Token inválido ou expirado
422 Erro de validação dos dados