Nunciatura Provista

API Documentation V1

Listar Questionários

Retorna a lista de questionários filtrável por grupo e tipo

Endpoint Protected

Descrição

Retorna a lista de questionários do sistema com as seguintes funcionalidades:

  • Filtro por group_id (UUID do grupo do processo ativo)
  • Filtro por type (questionario | carta)
  • Inclui indicador de fluxo (indicator: g1q1, g1q2, g1q3, g2..g6)
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/questionnaires?group_id={uuid}&type={questionario|carta}

Parâmetros de Query

Parâmetro Tipo Obrigatório Descrição
group_id string (UUID) Não Filtrar por ID do grupo
type string Não Tipo do questionário: questionario | carta

Cabeçalhos

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

Sucesso - 200

{
  "success": true,
  "data": [
    { "id": "...", "title": "...", "group_id": "...", "questionnaire_type": "questionario|carta", "indicator": "g1q1|g1q2|g1q3|g2..g6" }
  ]
}

Erro - 401 (Token inválido)

{
  "success": false,
  "message": "Token não fornecido"
}

Códigos de Resposta

Código Descrição
200 Lista de questionários retornada com sucesso
401 Token inválido ou expirado