Exportar Lista de Usuários em PDF

Gera e baixa um arquivo PDF com a lista de usuários 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 administradores aplicando os mesmos filtros da listagem padrão. O PDF inclui:

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 usuários, filtros aplicados)
Tabela com todos os usuários administradores (sem paginação) e dados essenciais: Nome, Sobrenome, Email, Verificação Email (dd/mm/aaaa hh:mm:ss), Data Criação (dd/mm/aaaa hh:mm:ss), Data Atualização (dd/mm/aaaa hh:mm:ss), Role
Numeração automática de páginas no rodapé
Suporte aos mesmos filtros da listagem (role, group_id, questionary_status, search)
Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/users/export/pdf

Parâmetros de Query

Campo	Tipo	Obrigatório	Descrição
role	string	Não	Filtrar por role (admin, informador)
group_id	uuid	Não	Filtrar por grupo eclesiástico (UUID)
questionary_status	string	Não	Filtrar por status do questionário (Pendente, Em andamento, Concluído)
search	string	Não	Buscar por nome ou email

Cabeçalhos

Parâmetro	Valor
Authorization	Bearer <token>
Accept	application/pdf

Respostas

Sucesso - 200

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

[Arquivo PDF binário]

Nota: O endpoint retorna um arquivo PDF diretamente. O nome do arquivo segue o padrão "lista-usuarios-YYYY-MM-DD.pdf" com a data atual de geração.

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 e baixado com sucesso
401	Token inválido ou expirado

Nunciatura Provista