Exportar Respostas em PDF (Consolidado)

Baixa um PDF único com todas as respostas concluídas de um questionário por processo e grupo

Este endpoint é do tipo: Protected

Descrição

Gera um PDF consolidado com todas as respostas concluídas do questionário indicado para um processo e grupo específicos. O arquivo contém:

Cabeçalho com identificação do processo, grupo e questionário
Quadro-resumo com data/hora da geração e total de respostas incluídas
Um bloco por resposta concluída, listando informador, data de envio e conteúdo integral
Renderização hierárquica das respostas (incluindo listas, objetos e textos longos)
Mensagens em português e formatação preparada para impressão (A4 retrato)

Somente respostas com status Concluído são incluídas. O PDF é ideal para arquivamento, auditoria e análise pelo time administrativo.

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/questionnaires/{questionnaireId}/answers/export/pdf

Path Parameters

Campo	Tipo	Obrigatório	Descrição
{questionnaireId}	uuid	Sim	Identificador do questionário alvo

Query Parameters

Campo	Tipo	Obrigatório	Descrição
process_id	uuid	Sim	Processo ao qual o questionário está vinculado
group_id	uuid	Sim	Grupo eclesiástico responsável pelas respostas

Cabeçalhos

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

Respostas

Sucesso - 200

Content-Type: application/pdf
Content-Disposition: attachment; filename="respostas_g1q1_2025-01-21_15-30-45.pdf"

[Arquivo PDF binário]

Nota: O nome do arquivo segue o padrão "respostas_{indicator ou slug do título}_YYYY-MM-DD_HH-mm-ss.pdf".

Erro - 422 (Validação)

{
  "success": false,
  "message": "Não foi possível gerar o PDF das respostas.",
  "errors": {
    "process_id": [
      "O processo é obrigatório."
    ]
  }
}

Condição: Parâmetros obrigatórios ausentes, UUID inválido ou questionário não associado ao grupo/processo informados.

Erro - 404 (Processo/Grupo/Questionário)

{
  "success": false,
  "message": "Processo não encontrado.",
  "errors": []
}

Condição: O processo, grupo ou relação com o questionário não foi localizado.

Códigos de Resposta

Código	Descrição
200	PDF gerado com sucesso e enviado para download
401	Token inválido, expirado ou ausente
404	Processo, grupo ou questionário não localizado
422	Falha de validação (parâmetros, relacionamento)

Nunciatura Provista