Nunciatura Provista

API Documentation V1

Exportar Lista de Informadores em PDF

Gera e baixa um arquivo PDF com a lista de informadores aplicando os mesmos filtros da listagem

Este endpoint é do tipo: Protected

Descrição

Gera e baixa um arquivo PDF com a lista de usuários com role de informador aplicando os mesmos filtros da listagem padrão. O PDF inclui:

  • Retorna apenas usuários com role de "informador"
  • Layout profissional otimizado para impressão (A4 paisagem)
  • Cabeçalho com informações do sistema e data de geração
  • Informações do relatório (total de informadores, filtros aplicados)
  • Tabela com todos os informadores (sem paginação) e dados essenciais: ID, Nome, Sobrenome, Email, CPF, Telefone, Categoria, Pronome, Diocese, Grupo, Processo, Protocolo do Processo, Verificação Email, Iniciais, Role, Data Criação, Data Atualização
  • Exibe nos filtros o processo associado ao grupo quando filtrado por grupo
  • Numeração automática de páginas no rodapé
  • Suporte aos mesmos filtros da listagem (group_id, diocese_id, category_id, search)
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/informers/export/pdf

Parâmetros de Query

Campo Tipo Obrigatório Descrição
group_id string (UUID) Não Filtrar por ID do grupo eclesiástico
diocese_id integer Não Filtrar por ID da diocese
category_id integer Não Filtrar por ID da categoria
search string Não Buscar por nome, sobrenome ou email do informador

Cabeçalhos

Parâmetro Valor
Authorization Bearer <token>

Exemplo de Requisição

GET /api/informers/export/pdf?group_id=uuid-do-grupo&category_id=5&search=João
Authorization: Bearer <token>

Respostas

Sucesso - 200

Content-Type: application/pdf
Content-Disposition: attachment; filename="lista-informadores-2025-01-21.pdf"

[Arquivo PDF binário - download direto]

Nota: Este endpoint retorna o arquivo PDF diretamente para download com nome baseado na data atual.

Erro - 401 (Token inválido)

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

Condição: Token JWT inválido, expirado ou não fornecido

Códigos de Resposta

Código Descrição
200 PDF gerado com sucesso
401 Token de autenticação inválido ou expirado
500 Erro interno do servidor