Nunciatura Provista

API Documentation V1

Exportar Resposta do Informador em DOCX

Baixa a resposta de um questionário em Word (.docx)

Endpoint Protected

Descrição

Gera um arquivo Word (.docx) com a resposta do questionário (em andamento ou concluída), utilizando a mesma fonte de dados e templates do endpoint de exportação em PDF GET .../answers/export/pdf. Ideal para o botão "Baixar DOCX" na tela de resposta do questionário.

O conteúdo segue o mesmo layout do PDF (cartas dos grupos 2 a 6, questionários do Grupo 1 e modelo genérico). Requer autenticação (Bearer token).

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

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

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

Query String (opcional)

Parâmetro Valores Descrição
disposition attachment (padrão) | inline Define se o navegador deve baixar ou exibir inline

Cabeçalhos

Parâmetro Valor
Authorization Bearer <token>
Accept application/vnd.openxmlformats-officedocument.wordprocessingml.document (opcional)

Resposta 200 (sucesso)

Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
Content-Disposition: attachment; filename="resposta_questionario_carta_grupo_5_frei_jorge_fonseca_brito.docx"

[Corpo binário do DOCX]

Respostas de erro (JSON)

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

Códigos de Resposta

Código Descrição
200 DOCX gerado
401 Token inválido ou ausente
404 Processo, grupo, questionário, informador ou resposta não encontrado
422 Relação inválida entre recursos
500 Falha ao gerar o arquivo Word