Nunciatura Provista

API Documentation V1

Exportar Respostas do Informador

Consolida todas as respostas concluídas de um informador em um único PDF

Este endpoint é do tipo: Protected

Descrição

Gera um PDF único contendo todas as respostas concluídas do informador para o processo e grupo informados. Cada questionário aparece em uma seção independente com o respectivo conteúdo.

  • Aplica-se automaticamente a qualquer grupo (Grupo 1 terá até 3 seções; demais grupos, uma seção);
  • Inclui cabeçalho com dados do processo, grupo, informador e timestamp de geração;
  • Fornece aviso visual quando algum questionário ainda não foi enviado, mantendo o relatório completo;
  • Ideal para download direto no painel administrativo.

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/informers/{informerId}/answers/export/pdf

Path Parameters

Campo Tipo Obrigatório Descrição
{informerId} uuid Sim Identificador do informador (registro na tabela informers)

Query Parameters

Campo Tipo Obrigatório Descrição
process_id uuid Sim Identificador do processo ativo do grupo

Cabeçalhos

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

Respostas

Sucesso - 200

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

[Arquivo PDF binário]

Nota: O nome do arquivo usa o nome do informador e o grupo (slug) seguidos da data e hora de geração.

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

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

Condição: Process ID inválido, informador sem grupo associado ou usuário inexistente.

Erro - 422 (Sem respostas concluídas)

{
  "success": false,
  "message": "Este informador ainda não concluiu respostas para o processo selecionado.",
  "errors": []
}

Condição: Nenhum questionário está com status "Concluído" para o informador/processo informado.

Códigos de Resposta

Código Descrição
200 PDF gerado e enviado com sucesso
401 Token ausente, inválido ou expirado
404 Processo, grupo ou usuário não localizado
422 Nenhuma resposta concluída ou parâmetros inválidos