Nunciatura Provista

API Documentation V1

Resposta de Questionário por Informador

Carrega a resposta de um questionário para um informador em um processo e grupo específicos

Endpoint Protected

Descrição

Retorna, em formato JSON, a resposta (rascunho ou final) de um questionário respondido por um informador específico, dentro de um determinado processo e grupo.

Este endpoint é pensado para a tela administrativa de Lista de Informadores, onde já se conhece o contexto de processo → grupo → questionário → informador.

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

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

Parâmetros de Caminho (Path)

Parâmetro Tipo Obrigatório Descrição
process_id string (UUID) Sim Identificador do processo (provisão)
group_id string (UUID) Sim Identificador do grupo eclesiástico do processo
informer_id string (UUID) Sim Identificador do informador (pode ser informer_id ou user_id)
questionnaire_id string (UUID) Sim Identificador do questionário (ex.: g1q1, g1q2, g1q3)

Resposta 200

{
  "success": true,
  "data": {
    "process": {
      "id": "uuid-processo",
      "name": "Provisão Diocese de Sapiranga - RS",
      "protocol": "PROV-2025-001"
    },
    "group": {
      "id": "uuid-grupo",
      "name": "Grupo 1"
    },
    "informer": {
      "id": "uuid-informer",
      "user_id": "uuid-usuario",
      "name": "Sergio Borges",
      "email": "sergio@email.com",
      "cpf": "12345678901",
      "function": "Consultor diocesano"
    },
    "questionnaire": {
      "id": "uuid-questionario",
      "title": "Indicação de informadores",
      "indicator": "g1q1",
      "questionnaire_type": "questionario"
    },
    "answer": {
      "id": "uuid-resposta",
      "questionnaire_id": "uuid-questionario",
      "user_id": "uuid-usuario",
      "process_id": "uuid-processo",
      "group_id": "uuid-grupo",
      "questionnaire_version": 1,
      "answers": { /* objeto com as respostas preenchidas */ },
      "status": "Concluído",
      "submitted_at": "2025-01-15T10:30:00.000000Z",
      "created_at": "2025-01-15T10:00:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  },
  "message": "Resposta do questionário carregada com sucesso."
}

Quando o informador ainda não respondeu

{
  "success": true,
  "data": {
    "process": { "...": "..." },
    "group": { "...": "..." },
    "informer": { "...": "..." },
    "questionnaire": { "...": "..." },
    "answer": null
  },
  "message": "Nenhuma resposta encontrada para este questionário."
}

Códigos de Resposta

Código Descrição
200 Contexto válido retornado (com ou sem resposta)
404 Processo, grupo, questionário ou informador não encontrado
422 Relação inválida entre processo, grupo, questionário e informador