Nunciatura Provista

API Documentation V1

Exportar Resposta do Informador em PDF

Baixa a resposta de um questionário em PDF (contexto processo/grupo/informador)

Endpoint Protected

Descrição

Gera um PDF em formato A4 com a resposta do questionário (em andamento ou concluída), utilizando a mesma fonte de dados do endpoint de visualização GET .../answers. Ideal para o botão "Baixar PDF" na tela de resposta do questionário: o front faz um GET nesta URL e dispara o download, sem gerar PDF no navegador.

O layout do PDF varia conforme o questionário: G1Q1 (Indicação de informadores) usa o modelo em formato de carta (cabeçalho da diocese, protocolo, data, informadores indicados, conclusão e assinatura). Os demais questionários usam o modelo genérico com contexto e conteúdo hierárquico.

PDF pode ser exportado para respostas em qualquer status (Em andamento ou Concluído). Requer autenticação (Bearer token).

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/processes/{process_id}/groups/{group_id}/informers/{informer_id}/questionnaires/{questionnaire_id}/answers/export/pdf

Parâmetros de Caminho (Path)

Parâmetro Tipo Obrigatório Descrição
process_id string (UUID) Sim Identificador do processo
group_id string (UUID) Sim Identificador do grupo eclesiástico
informer_id string (UUID) Sim Identificador do informador (ou user_id)
questionnaire_id string (UUID) Sim Identificador do questionário

Cabeçalhos

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

Resposta 200 (sucesso)

Content-Type: application/pdf
Content-Disposition: attachment; filename="resposta_questionario_indicacao_informadores_pedro_marques.pdf"

[Corpo binário do PDF]

O nome do arquivo é definido pelo back-end (título do questionário + nome do informador, em slug).

Respostas de erro (JSON)

Quando não for possível gerar o PDF (resposta inexistente, recurso não encontrado), a API retorna JSON com success: false.

{
  "success": false,
  "message": "Nenhuma resposta encontrada para este questionário.",
  "errors": []
}

Códigos de Resposta

Código Descrição
200 PDF gerado (application/pdf)
401 Token inválido ou ausente
404 Processo, grupo, questionário, informador ou resposta não encontrado
422 Relação inválida entre recursos