Nunciatura Provista

API Documentation V1

Remover Informador do Grupo

Remove um informador de um grupo específico

Este endpoint é do tipo: Protected

Descrição

Remove um informador de um grupo específico de um processo. O histórico de mudanças é registrado automaticamente.

  • Remove o informador do grupo especificado de um processo
  • Registra automaticamente o histórico de mudanças na tabela informer_group_history
  • Fecha o registro anterior do grupo no histórico
  • Valida se o informador existe e está no grupo/processo especificado
  • Valida se o grupo pertence ao processo informado
  • Retorna os dados atualizados do informador
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

DELETE

URL BASE

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

ENDPOINT

/groups/{group_id}/informers/{informer_id}

Parâmetros de URL

Parâmetro Tipo Obrigatório Descrição
group_id string (UUID) Sim ID do grupo do qual o informador será removido
informer_id string (UUID) Sim ID do informador que será removido do grupo

Body (JSON)

Campo Tipo Obrigatório Descrição
process_id string (UUID) Sim ID do processo ao qual o grupo pertence
reason string Não Motivo customizado para o histórico (máx. 500 caracteres). Se não informado, será usado "Removido do grupo/processo"

Cabeçalhos

Parâmetro Valor
Authorization Bearer <token>

Respostas

Requisição

DELETE /api/v1/groups/{group_id}/informers/{informer_id}
Content-Type: application/json
Authorization: Bearer {token}

{
    "process_id": "987e6543-e21b-34d5-b789-123456789012",
    "reason": "Solicitação de remoção"
}

Sucesso - 200

{
  "success": true,
  "data": {
    "id": "uuid-usuario",
    "informador_id": "uuid-informador",
    "group": {
      "id": "uuid-grupo",
      "name": "Grupo 1"
    },
    "process": {
      "id": "uuid-processo",
      "name": "Arquidiocese de Recife",
      "protocol": "PROV-2025-001"
    }
  },
  "message": "Informador removido do grupo 'Grupo 1' no processo 'Arquidiocese de Recife' com sucesso"
}