Nunciatura Provista

API Documentation V1

Exportar Resposta Individual em PDF

Baixa um PDF com a resposta concluída de um informador específico

Este endpoint é do tipo: Protected

Descrição

Gera um PDF contendo a resposta integral enviada pelo informador. O arquivo inclui:

  • Contexto do processo, grupo e questionário
  • Identificação do informador e data/hora do envio
  • Conteúdo hierárquico da resposta com os mesmos campos disponíveis na aplicação
  • Texto renderizado preservando quebras de linha e listas
  • Formatação pronta para distribuição ou arquivamento (A4 retrato)

Apenas respostas com status Concluído podem ser exportadas. O uso é exclusivo de administradores autenticados.

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

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

Path Parameters

Campo Tipo Obrigatório Descrição
{questionnaireId} uuid Sim Identificador do questionário
{answerId} uuid Sim Identificador da resposta concluída

Query Parameters

Este endpoint não utiliza parâmetros de query adicionais.

Cabeçalhos

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

Respostas

Sucesso - 200

Content-Type: application/pdf
Content-Disposition: attachment; filename="resposta_maria_silva_2025-01-21_15-42-10.pdf"

[Arquivo PDF binário]

Nota: O nome do arquivo utiliza o nome do informador (quando disponível) e timestamp no formato "resposta_{slug-nome}_{data}_ {hora}.pdf".

Erro - 422 (Resposta não concluída)

{
  "success": false,
  "message": "Esta resposta ainda não foi concluída.",
  "errors": []
}

Condição: A resposta ainda está como rascunho ou em andamento.

Erro - 404 (Questionário ou resposta)

{
  "success": false,
  "message": "A resposta informada não pertence a este questionário.",
  "errors": []
}

Condição: O UUID não está associado ao questionário indicado ou já foi removido.

Códigos de Resposta

Código Descrição
200 PDF gerado com sucesso
401 Token inválido, ausente ou expirado
404 Questionário ou resposta não localizado
422 Resposta ainda não concluída